<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>dfeofdm: Overview</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">dfeofdm
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__dfeofdm.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Overview</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dfe_ofdm___version.html">XDfeOfdm_Version</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">LogiCORE version.  <a href="struct_x_dfe_ofdm___version.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dfe_ofdm___trigger.html">XDfeOfdm_Trigger</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Trigger configuration.  <a href="struct_x_dfe_ofdm___trigger.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dfe_ofdm___trigger_cfg.html">XDfeOfdm_TriggerCfg</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">All IP triggers.  <a href="struct_x_dfe_ofdm___trigger_cfg.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dfe_ofdm___c_c_sequence.html">XDfeOfdm_CCSequence</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines a CCID sequence.  <a href="struct_x_dfe_ofdm___c_c_sequence.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dfe_ofdm___f_t_sequence.html">XDfeOfdm_FTSequence</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines an FT sequence.  <a href="struct_x_dfe_ofdm___f_t_sequence.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dfe_ofdm___model_parameters.html">XDfeOfdm_ModelParameters</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">OFDM model parameters structure.  <a href="struct_x_dfe_ofdm___model_parameters.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dfe_ofdm___cfg.html">XDfeOfdm_Cfg</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configuration.  <a href="struct_x_dfe_ofdm___cfg.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dfe_ofdm___init.html">XDfeOfdm_Init</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialization, "one-time" configuration parameters.  <a href="struct_x_dfe_ofdm___init.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dfe_ofdm___carrier_cfg.html">XDfeOfdm_CarrierCfg</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configuration for a single CC.  <a href="struct_x_dfe_ofdm___carrier_cfg.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dfe_ofdm___internal_carrier_cfg.html">XDfeOfdm_InternalCarrierCfg</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internal configuration for a single CC.  <a href="struct_x_dfe_ofdm___internal_carrier_cfg.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dfe_ofdm___c_c_cfg.html">XDfeOfdm_CCCfg</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Full CC configuration.  <a href="struct_x_dfe_ofdm___c_c_cfg.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dfe_ofdm___status.html">XDfeOfdm_Status</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">OFDM Status.  <a href="struct_x_dfe_ofdm___status.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dfe_ofdm___interrupt_mask.html">XDfeOfdm_InterruptMask</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Interrupt mask.  <a href="struct_x_dfe_ofdm___interrupt_mask.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dfe_ofdm___config.html">XDfeOfdm_Config</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">OFDM Configuration structure.  <a href="struct_x_dfe_ofdm___config.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">OFDM Structure.  <a href="struct_x_dfe_ofdm.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gab4ee35983c0d92285d640affefc3dcad"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#gab4ee35983c0d92285d640affefc3dcad">XDFEOFDM_DRIVER_VERSION_MINOR</a>&#160;&#160;&#160;(3U)</td></tr>
<tr class="memdesc:gab4ee35983c0d92285d640affefc3dcad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Minor version number of driver.  <a href="#gab4ee35983c0d92285d640affefc3dcad">More...</a><br/></td></tr>
<tr class="separator:gab4ee35983c0d92285d640affefc3dcad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaca6bdd93682f011cf7af49604858e6c4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#gaca6bdd93682f011cf7af49604858e6c4">XDFEOFDM_DRIVER_VERSION_MAJOR</a>&#160;&#160;&#160;(1U)</td></tr>
<tr class="memdesc:gaca6bdd93682f011cf7af49604858e6c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Major version number of driver.  <a href="#gaca6bdd93682f011cf7af49604858e6c4">More...</a><br/></td></tr>
<tr class="separator:gaca6bdd93682f011cf7af49604858e6c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae4d82a1199fcbbeff474569c036edeac"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#gae4d82a1199fcbbeff474569c036edeac">XDFEOFDM_PHASE_COMPENSATION_REG_STEP</a>&#160;&#160;&#160;8U</td></tr>
<tr class="memdesc:gae4d82a1199fcbbeff474569c036edeac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Address space step between space for phase compensation on one carrier.  <a href="#gae4d82a1199fcbbeff474569c036edeac">More...</a><br/></td></tr>
<tr class="separator:gae4d82a1199fcbbeff474569c036edeac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga37d661eaba3931cc94c8e2f3bdef2775"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#ga37d661eaba3931cc94c8e2f3bdef2775">XDFEOFDM_FREQUENCY_RANGE_1</a>&#160;&#160;&#160;0U</td></tr>
<tr class="memdesc:ga37d661eaba3931cc94c8e2f3bdef2775"><td class="mdescLeft">&#160;</td><td class="mdescRight">[15, 30, 60] kHz (default)  <a href="#ga37d661eaba3931cc94c8e2f3bdef2775">More...</a><br/></td></tr>
<tr class="separator:ga37d661eaba3931cc94c8e2f3bdef2775"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0f37ddff73e8d1fa275d44da5803846e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#ga0f37ddff73e8d1fa275d44da5803846e">XDFEOFDM_FREQUENCY_RANGE_2</a>&#160;&#160;&#160;1U</td></tr>
<tr class="memdesc:ga0f37ddff73e8d1fa275d44da5803846e"><td class="mdescLeft">&#160;</td><td class="mdescRight">[60, 120, 240, 480, 960] kHz  <a href="#ga0f37ddff73e8d1fa275d44da5803846e">More...</a><br/></td></tr>
<tr class="separator:ga0f37ddff73e8d1fa275d44da5803846e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga845d4be1302f35864f7c53001bb4d793"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#ga845d4be1302f35864f7c53001bb4d793">XDFEOFDM_MAX_NUM_INSTANCES</a>&#160;&#160;&#160;(10U)</td></tr>
<tr class="memdesc:ga845d4be1302f35864f7c53001bb4d793"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum number of driver instances running at the same time.  <a href="#ga845d4be1302f35864f7c53001bb4d793">More...</a><br/></td></tr>
<tr class="separator:ga845d4be1302f35864f7c53001bb4d793"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac89bab3faf02d647cf50864711fcde4e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#gac89bab3faf02d647cf50864711fcde4e">XDFEOFDM_INSTANCE_EXISTS</a>(X)&#160;&#160;&#160;(X &lt; <a class="el" href="group__dfeofdm.html#ga845d4be1302f35864f7c53001bb4d793">XDFEOFDM_MAX_NUM_INSTANCES</a>)</td></tr>
<tr class="memdesc:gac89bab3faf02d647cf50864711fcde4e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of instances that exist at any given time.  <a href="#gac89bab3faf02d647cf50864711fcde4e">More...</a><br/></td></tr>
<tr class="separator:gac89bab3faf02d647cf50864711fcde4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga959ffc15251ddc9b3a883a30f97b7715"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#ga959ffc15251ddc9b3a883a30f97b7715">XST_SUCCESS</a>&#160;&#160;&#160;(0U)</td></tr>
<tr class="memdesc:ga959ffc15251ddc9b3a883a30f97b7715"><td class="mdescLeft">&#160;</td><td class="mdescRight">Success flag.  <a href="#ga959ffc15251ddc9b3a883a30f97b7715">More...</a><br/></td></tr>
<tr class="separator:ga959ffc15251ddc9b3a883a30f97b7715"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9478d2b97aa40e09052dee2571940ef9"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#ga9478d2b97aa40e09052dee2571940ef9">XST_FAILURE</a>&#160;&#160;&#160;(1U)</td></tr>
<tr class="memdesc:ga9478d2b97aa40e09052dee2571940ef9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Failure flag.  <a href="#ga9478d2b97aa40e09052dee2571940ef9">More...</a><br/></td></tr>
<tr class="separator:ga9478d2b97aa40e09052dee2571940ef9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2b1ba159bec0d962b41efafc034d2eae"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#ga2b1ba159bec0d962b41efafc034d2eae">XDFEOFDM_NODE_NAME_MAX_LENGTH</a>&#160;&#160;&#160;(50U)</td></tr>
<tr class="memdesc:ga2b1ba159bec0d962b41efafc034d2eae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Node name maximum length.  <a href="#ga2b1ba159bec0d962b41efafc034d2eae">More...</a><br/></td></tr>
<tr class="separator:ga2b1ba159bec0d962b41efafc034d2eae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab8b2ac9b5c081fc45107e1e5f682b157"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#gab8b2ac9b5c081fc45107e1e5f682b157">XDFEOFDM_CC_NUM</a>&#160;&#160;&#160;(16)</td></tr>
<tr class="memdesc:gab8b2ac9b5c081fc45107e1e5f682b157"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum CC sequence number.  <a href="#gab8b2ac9b5c081fc45107e1e5f682b157">More...</a><br/></td></tr>
<tr class="separator:gab8b2ac9b5c081fc45107e1e5f682b157"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9f3b3e7ef1ded7f8fdb9019cc06945c7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#ga9f3b3e7ef1ded7f8fdb9019cc06945c7">XDFEOFDM_FT_NUM</a>&#160;&#160;&#160;(16)</td></tr>
<tr class="memdesc:ga9f3b3e7ef1ded7f8fdb9019cc06945c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum FT sequence number.  <a href="#ga9f3b3e7ef1ded7f8fdb9019cc06945c7">More...</a><br/></td></tr>
<tr class="separator:ga9f3b3e7ef1ded7f8fdb9019cc06945c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae1b70fbbb2d556355abe4fb78ee9a1ee"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#gae1b70fbbb2d556355abe4fb78ee9a1ee">XDFEOFDM_CC_SEQ_LENGTH_MAX</a>&#160;&#160;&#160;(16U)</td></tr>
<tr class="memdesc:gae1b70fbbb2d556355abe4fb78ee9a1ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum sequence length.  <a href="#gae1b70fbbb2d556355abe4fb78ee9a1ee">More...</a><br/></td></tr>
<tr class="separator:gae1b70fbbb2d556355abe4fb78ee9a1ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad235a4fa132b4f4c9beb9cfee8ddce9e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#gad235a4fa132b4f4c9beb9cfee8ddce9e">XDFEOFDM_FT_SEQ_LENGTH_MAX</a>&#160;&#160;&#160;(16U)</td></tr>
<tr class="memdesc:gad235a4fa132b4f4c9beb9cfee8ddce9e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum Fourier transform sequence length.  <a href="#gad235a4fa132b4f4c9beb9cfee8ddce9e">More...</a><br/></td></tr>
<tr class="separator:gad235a4fa132b4f4c9beb9cfee8ddce9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8781db2b27a846747e58ff160bea6751"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#ga8781db2b27a846747e58ff160bea6751">XDFEOFDM_PHASE_COMPENSATION_MAX</a>&#160;&#160;&#160;(112U)</td></tr>
<tr class="memdesc:ga8781db2b27a846747e58ff160bea6751"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum phase compensation weight.  <a href="#ga8781db2b27a846747e58ff160bea6751">More...</a><br/></td></tr>
<tr class="separator:ga8781db2b27a846747e58ff160bea6751"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac0365d88ff2b68ab1265a08ced0b8c3e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#gac0365d88ff2b68ab1265a08ced0b8c3e">XDFEOFDM_COMPATIBLE_STRING</a>&#160;&#160;&#160;&quot;xlnx,xdfe-ofdm-2.2&quot;</td></tr>
<tr class="memdesc:gac0365d88ff2b68ab1265a08ced0b8c3e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Device name property.  <a href="#gac0365d88ff2b68ab1265a08ced0b8c3e">More...</a><br/></td></tr>
<tr class="separator:gac0365d88ff2b68ab1265a08ced0b8c3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7a63606234dc8bb5e3ecfc374ec08fcb"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#ga7a63606234dc8bb5e3ecfc374ec08fcb">XDFEOFDM_COMPATIBLE_STRING_2_1</a>&#160;&#160;&#160;&quot;xlnx,xdfe-ofdm-2.1&quot;</td></tr>
<tr class="memdesc:ga7a63606234dc8bb5e3ecfc374ec08fcb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Device name property.  <a href="#ga7a63606234dc8bb5e3ecfc374ec08fcb">More...</a><br/></td></tr>
<tr class="separator:ga7a63606234dc8bb5e3ecfc374ec08fcb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac19ea8ab6170b162ac40927cc7002254"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#gac19ea8ab6170b162ac40927cc7002254">XDFEOFDM_PLATFORM_DEVICE_DIR</a>&#160;&#160;&#160;&quot;/sys/bus/platform/devices/&quot;</td></tr>
<tr class="memdesc:gac19ea8ab6170b162ac40927cc7002254"><td class="mdescLeft">&#160;</td><td class="mdescRight">Device location in a file system.  <a href="#gac19ea8ab6170b162ac40927cc7002254">More...</a><br/></td></tr>
<tr class="separator:gac19ea8ab6170b162ac40927cc7002254"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae6de2b2534061e81fb5cfde6c33e36e7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#gae6de2b2534061e81fb5cfde6c33e36e7">XDFEOFDM_COMPATIBLE_PROPERTY</a>&#160;&#160;&#160;&quot;compatible&quot;</td></tr>
<tr class="memdesc:gae6de2b2534061e81fb5cfde6c33e36e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Device tree property.  <a href="#gae6de2b2534061e81fb5cfde6c33e36e7">More...</a><br/></td></tr>
<tr class="separator:gae6de2b2534061e81fb5cfde6c33e36e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaaa0a15327eb2c47371a1161d42d97a48"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#gaaa0a15327eb2c47371a1161d42d97a48">XDFEOFDM_BUS_NAME</a>&#160;&#160;&#160;&quot;platform&quot;</td></tr>
<tr class="memdesc:gaaa0a15327eb2c47371a1161d42d97a48"><td class="mdescLeft">&#160;</td><td class="mdescRight">System bus name.  <a href="#gaaa0a15327eb2c47371a1161d42d97a48">More...</a><br/></td></tr>
<tr class="separator:gaaa0a15327eb2c47371a1161d42d97a48"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga73fef423ca0f5af468481c7093d8c2ce"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#ga73fef423ca0f5af468481c7093d8c2ce">XDFEOFDM_BASEADDR_PROPERTY</a>&#160;&#160;&#160;&quot;reg&quot;</td></tr>
<tr class="memdesc:ga73fef423ca0f5af468481c7093d8c2ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base address property.  <a href="#ga73fef423ca0f5af468481c7093d8c2ce">More...</a><br/></td></tr>
<tr class="separator:ga73fef423ca0f5af468481c7093d8c2ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9674335dc9b55ab380ef815fcea351af"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#ga9674335dc9b55ab380ef815fcea351af">XDFEOFDM_BASEADDR_SIZE</a>&#160;&#160;&#160;8U</td></tr>
<tr class="memdesc:ga9674335dc9b55ab380ef815fcea351af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base address bit-size.  <a href="#ga9674335dc9b55ab380ef815fcea351af">More...</a><br/></td></tr>
<tr class="separator:ga9674335dc9b55ab380ef815fcea351af"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga8fe9073be4e4298b7c4bf8fe8c565b2a"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#ga8fe9073be4e4298b7c4bf8fe8c565b2a">XDfeOfdm_StateId</a> { <br/>
&#160;&#160;<a class="el" href="group__dfeofdm.html#gga8fe9073be4e4298b7c4bf8fe8c565b2aa18fda0537eb680a4d71a6565095c1b1a">XDFEOFDM_STATE_NOT_READY</a> = 0, 
<a class="el" href="group__dfeofdm.html#gga8fe9073be4e4298b7c4bf8fe8c565b2aa56db899ae9d39e13af58ecb472ef9448">XDFEOFDM_STATE_READY</a>, 
<a class="el" href="group__dfeofdm.html#gga8fe9073be4e4298b7c4bf8fe8c565b2aa4bb607567495464ddbb620d55a620509">XDFEOFDM_STATE_RESET</a>, 
<a class="el" href="group__dfeofdm.html#gga8fe9073be4e4298b7c4bf8fe8c565b2aa80209d129faeae7e529b68c3927db3cf">XDFEOFDM_STATE_CONFIGURED</a>, 
<br/>
&#160;&#160;<a class="el" href="group__dfeofdm.html#gga8fe9073be4e4298b7c4bf8fe8c565b2aa697df6f5fef047d5a215f24b86203c04">XDFEOFDM_STATE_INITIALISED</a>, 
<a class="el" href="group__dfeofdm.html#gga8fe9073be4e4298b7c4bf8fe8c565b2aab5e131c361e68b90e4351670b9b6ec85">XDFEOFDM_STATE_OPERATIONAL</a>
<br/>
 }</td></tr>
<tr class="separator:ga8fe9073be4e4298b7c4bf8fe8c565b2a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga432a6579323bb9a5ec591489ffc2ac0f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#ga432a6579323bb9a5ec591489ffc2ac0f">XDfeOfdm_InstanceInit</a> (const char *DeviceNodeName)</td></tr>
<tr class="memdesc:ga432a6579323bb9a5ec591489ffc2ac0f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes one instance of the OFDM driver and traverses the "/sys/bus/platform/device" directory (in Linux) to find the registered OFDM device with the name DeviceNodeName.  <a href="#ga432a6579323bb9a5ec591489ffc2ac0f">More...</a><br/></td></tr>
<tr class="separator:ga432a6579323bb9a5ec591489ffc2ac0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga765082b84acafa5bcef9c2ad92bb7cf6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#ga765082b84acafa5bcef9c2ad92bb7cf6">XDfeOfdm_InstanceClose</a> (<a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga765082b84acafa5bcef9c2ad92bb7cf6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Closes the instances of the OFDM driver and moves the state machine to a Not Ready state.  <a href="#ga765082b84acafa5bcef9c2ad92bb7cf6">More...</a><br/></td></tr>
<tr class="separator:ga765082b84acafa5bcef9c2ad92bb7cf6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga337fe11e6ef1bef0727ba3b9ee59b10f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#ga337fe11e6ef1bef0727ba3b9ee59b10f">XDfeOfdm_Reset</a> (<a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga337fe11e6ef1bef0727ba3b9ee59b10f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resets the OFDM instance and puts block into a reset state.  <a href="#ga337fe11e6ef1bef0727ba3b9ee59b10f">More...</a><br/></td></tr>
<tr class="separator:ga337fe11e6ef1bef0727ba3b9ee59b10f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8248b6bc1f2f9dd0f5b2a04c62062753"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#ga8248b6bc1f2f9dd0f5b2a04c62062753">XDfeOfdm_Configure</a> (<a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *InstancePtr, <a class="el" href="struct_x_dfe_ofdm___cfg.html">XDfeOfdm_Cfg</a> *Cfg)</td></tr>
<tr class="memdesc:ga8248b6bc1f2f9dd0f5b2a04c62062753"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads configuration from device tree/xparameters.h and IP registers.  <a href="#ga8248b6bc1f2f9dd0f5b2a04c62062753">More...</a><br/></td></tr>
<tr class="separator:ga8248b6bc1f2f9dd0f5b2a04c62062753"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga01a406ff1a9f5562ee5fc7c7a28ea237"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#ga01a406ff1a9f5562ee5fc7c7a28ea237">XDfeOfdm_Initialize</a> (<a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *InstancePtr, <a class="el" href="struct_x_dfe_ofdm___init.html">XDfeOfdm_Init</a> *Init)</td></tr>
<tr class="memdesc:ga01a406ff1a9f5562ee5fc7c7a28ea237"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the OFDM driver and moves the state machine to an initialized state.  <a href="#ga01a406ff1a9f5562ee5fc7c7a28ea237">More...</a><br/></td></tr>
<tr class="separator:ga01a406ff1a9f5562ee5fc7c7a28ea237"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga17cc3a5b3f29a0dc0065018d0fe3ec98"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#ga17cc3a5b3f29a0dc0065018d0fe3ec98">XDfeOfdm_Activate</a> (<a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *InstancePtr, bool EnableLowPower)</td></tr>
<tr class="memdesc:ga17cc3a5b3f29a0dc0065018d0fe3ec98"><td class="mdescLeft">&#160;</td><td class="mdescRight">Activates OFDM and moves the state machine to an activated state.  <a href="#ga17cc3a5b3f29a0dc0065018d0fe3ec98">More...</a><br/></td></tr>
<tr class="separator:ga17cc3a5b3f29a0dc0065018d0fe3ec98"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8c3460b747d8e053c0bcb66a36b1a827"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#ga8c3460b747d8e053c0bcb66a36b1a827">XDfeOfdm_Deactivate</a> (<a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga8c3460b747d8e053c0bcb66a36b1a827"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deactivates OFDM and moves the state machine to an initialised state.  <a href="#ga8c3460b747d8e053c0bcb66a36b1a827">More...</a><br/></td></tr>
<tr class="separator:ga8c3460b747d8e053c0bcb66a36b1a827"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga090de51506092c4ad878aea98e85bec2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__dfeofdm.html#ga8fe9073be4e4298b7c4bf8fe8c565b2a">XDfeOfdm_StateId</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#ga090de51506092c4ad878aea98e85bec2">XDfeOfdm_GetStateID</a> (<a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga090de51506092c4ad878aea98e85bec2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets a state machine state ID.  <a href="#ga090de51506092c4ad878aea98e85bec2">More...</a><br/></td></tr>
<tr class="separator:ga090de51506092c4ad878aea98e85bec2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga895d37558bb4351d118f1970d79a2d7b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#ga895d37558bb4351d118f1970d79a2d7b">XDfeOfdm_GetCurrentCCCfg</a> (const <a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *InstancePtr, <a class="el" href="struct_x_dfe_ofdm___c_c_cfg.html">XDfeOfdm_CCCfg</a> *CurrCCCfg)</td></tr>
<tr class="memdesc:ga895d37558bb4351d118f1970d79a2d7b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the current CC configuration.  <a href="#ga895d37558bb4351d118f1970d79a2d7b">More...</a><br/></td></tr>
<tr class="separator:ga895d37558bb4351d118f1970d79a2d7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0f253b33e1be8d4b37bbddf681669a13"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#ga0f253b33e1be8d4b37bbddf681669a13">XDfeOfdm_GetEmptyCCCfg</a> (const <a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *InstancePtr, <a class="el" href="struct_x_dfe_ofdm___c_c_cfg.html">XDfeOfdm_CCCfg</a> *CCCfg)</td></tr>
<tr class="memdesc:ga0f253b33e1be8d4b37bbddf681669a13"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns configuration structure CCCfg with CCCfg-&gt;CCSequence.Length value set in <a class="el" href="group__dfeofdm.html#ga8248b6bc1f2f9dd0f5b2a04c62062753" title="Reads configuration from device tree/xparameters.h and IP registers. ">XDfeOfdm_Configure()</a>, array CCCfg-&gt;CCSequence.CCID[] members are set to not used value (-1) and the other CCCfg members are set to 0.  <a href="#ga0f253b33e1be8d4b37bbddf681669a13">More...</a><br/></td></tr>
<tr class="separator:ga0f253b33e1be8d4b37bbddf681669a13"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gade552f0bcf5ed9eac51ca4fcc4b983fa"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#gade552f0bcf5ed9eac51ca4fcc4b983fa">XDfeOfdm_AddCCtoCCCfg</a> (<a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *InstancePtr, <a class="el" href="struct_x_dfe_ofdm___c_c_cfg.html">XDfeOfdm_CCCfg</a> *CCCfg, s32 CCID, u32 CCSeqBitmap, const <a class="el" href="struct_x_dfe_ofdm___carrier_cfg.html">XDfeOfdm_CarrierCfg</a> *CarrierCfg, <a class="el" href="struct_x_dfe_ofdm___f_t_sequence.html">XDfeOfdm_FTSequence</a> *FTSeq)</td></tr>
<tr class="memdesc:gade552f0bcf5ed9eac51ca4fcc4b983fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds specified CCID, with specified configuration, to a local CC configuration structure.  <a href="#gade552f0bcf5ed9eac51ca4fcc4b983fa">More...</a><br/></td></tr>
<tr class="separator:gade552f0bcf5ed9eac51ca4fcc4b983fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa9f6889b400fc2fcd705f0760c6fa696"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#gaa9f6889b400fc2fcd705f0760c6fa696">XDfeOfdm_GetCarrierCfg</a> (const <a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *InstancePtr, <a class="el" href="struct_x_dfe_ofdm___c_c_cfg.html">XDfeOfdm_CCCfg</a> *CCCfg, s32 CCID, u32 *CCSeqBitmap, <a class="el" href="struct_x_dfe_ofdm___carrier_cfg.html">XDfeOfdm_CarrierCfg</a> *CarrierCfg)</td></tr>
<tr class="memdesc:gaa9f6889b400fc2fcd705f0760c6fa696"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the current CCID carrier configuration.  <a href="#gaa9f6889b400fc2fcd705f0760c6fa696">More...</a><br/></td></tr>
<tr class="separator:gaa9f6889b400fc2fcd705f0760c6fa696"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga030e66a15c8f0c1b4493aa605dca2c30"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#ga030e66a15c8f0c1b4493aa605dca2c30">XDfeOfdm_RemoveCCfromCCCfg</a> (<a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *InstancePtr, <a class="el" href="struct_x_dfe_ofdm___c_c_cfg.html">XDfeOfdm_CCCfg</a> *CCCfg, s32 CCID, <a class="el" href="struct_x_dfe_ofdm___f_t_sequence.html">XDfeOfdm_FTSequence</a> *FTSeq)</td></tr>
<tr class="memdesc:ga030e66a15c8f0c1b4493aa605dca2c30"><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes specified CCID from a local CC configuration structure.  <a href="#ga030e66a15c8f0c1b4493aa605dca2c30">More...</a><br/></td></tr>
<tr class="separator:ga030e66a15c8f0c1b4493aa605dca2c30"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga38d91645f0bc01f170a6333fb22f47cd"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#ga38d91645f0bc01f170a6333fb22f47cd">XDfeOfdm_UpdateCCinCCCfg</a> (<a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *InstancePtr, <a class="el" href="struct_x_dfe_ofdm___c_c_cfg.html">XDfeOfdm_CCCfg</a> *CCCfg, s32 CCID, const <a class="el" href="struct_x_dfe_ofdm___carrier_cfg.html">XDfeOfdm_CarrierCfg</a> *CarrierCfg, <a class="el" href="struct_x_dfe_ofdm___f_t_sequence.html">XDfeOfdm_FTSequence</a> *FTSeq)</td></tr>
<tr class="memdesc:ga38d91645f0bc01f170a6333fb22f47cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates a specified CCID with the specified configuration to a local CC configuration structure.  <a href="#ga38d91645f0bc01f170a6333fb22f47cd">More...</a><br/></td></tr>
<tr class="separator:ga38d91645f0bc01f170a6333fb22f47cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaef40749e07cdc3a4a00a2e8228d5d8b8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#gaef40749e07cdc3a4a00a2e8228d5d8b8">XDfeOfdm_SetNextCCCfg</a> (const <a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *InstancePtr, const <a class="el" href="struct_x_dfe_ofdm___c_c_cfg.html">XDfeOfdm_CCCfg</a> *NextCCCfg)</td></tr>
<tr class="memdesc:gaef40749e07cdc3a4a00a2e8228d5d8b8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the next CC configuration.  <a href="#gaef40749e07cdc3a4a00a2e8228d5d8b8">More...</a><br/></td></tr>
<tr class="separator:gaef40749e07cdc3a4a00a2e8228d5d8b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac49b03eaed4ce4083b5d51650a121158"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#gac49b03eaed4ce4083b5d51650a121158">XDfeOfdm_EnableCCUpdateTrigger</a> (const <a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *InstancePtr)</td></tr>
<tr class="memdesc:gac49b03eaed4ce4083b5d51650a121158"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads the triggers and sets the enable bit of Update trigger.  <a href="#gac49b03eaed4ce4083b5d51650a121158">More...</a><br/></td></tr>
<tr class="separator:gac49b03eaed4ce4083b5d51650a121158"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9daeab383fd324e6812ae53d248ceeaa"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#ga9daeab383fd324e6812ae53d248ceeaa">XDfeOfdm_SetNextCCCfgAndTrigger</a> (const <a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *InstancePtr, <a class="el" href="struct_x_dfe_ofdm___c_c_cfg.html">XDfeOfdm_CCCfg</a> *CCCfg)</td></tr>
<tr class="memdesc:ga9daeab383fd324e6812ae53d248ceeaa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes local CC configuration to the shadow (NEXT) registers and triggers copying from shadow to operational registers.  <a href="#ga9daeab383fd324e6812ae53d248ceeaa">More...</a><br/></td></tr>
<tr class="separator:ga9daeab383fd324e6812ae53d248ceeaa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8432ece95eb4a12d2f1eb60e87436809"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#ga8432ece95eb4a12d2f1eb60e87436809">XDfeOfdm_GetTriggersCfg</a> (const <a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *InstancePtr, <a class="el" href="struct_x_dfe_ofdm___trigger_cfg.html">XDfeOfdm_TriggerCfg</a> *TriggerCfg)</td></tr>
<tr class="memdesc:ga8432ece95eb4a12d2f1eb60e87436809"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the current trigger configuration.  <a href="#ga8432ece95eb4a12d2f1eb60e87436809">More...</a><br/></td></tr>
<tr class="separator:ga8432ece95eb4a12d2f1eb60e87436809"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5e4d810d0e04bbad650fbb60115254e4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#ga5e4d810d0e04bbad650fbb60115254e4">XDfeOfdm_SetTriggersCfg</a> (const <a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *InstancePtr, <a class="el" href="struct_x_dfe_ofdm___trigger_cfg.html">XDfeOfdm_TriggerCfg</a> *TriggerCfg)</td></tr>
<tr class="memdesc:ga5e4d810d0e04bbad650fbb60115254e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the trigger configuration.  <a href="#ga5e4d810d0e04bbad650fbb60115254e4">More...</a><br/></td></tr>
<tr class="separator:ga5e4d810d0e04bbad650fbb60115254e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaef986bcb74ec77dff1a72b67deab3f9e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#gaef986bcb74ec77dff1a72b67deab3f9e">XDfeOfdm_SetTuserOutFrameLocation</a> (const <a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *InstancePtr, u32 TuserOutFrameLocation)</td></tr>
<tr class="memdesc:gaef986bcb74ec77dff1a72b67deab3f9e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the TUSER Framing bit location register where bit location indicates which bit to be used for sending the framing information on DL_DOUT IF and M_AXIS_TBASE IF.  <a href="#gaef986bcb74ec77dff1a72b67deab3f9e">More...</a><br/></td></tr>
<tr class="separator:gaef986bcb74ec77dff1a72b67deab3f9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga54bde32062a405022c4d2881439f61a2"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#ga54bde32062a405022c4d2881439f61a2">XDfeOfdm_GetTuserOutFrameLocation</a> (const <a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga54bde32062a405022c4d2881439f61a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the TUSER Framing bit location register where bit location indicates which bit to be used for sending framing information on DL_DOUT IF and M_AXIS_TBASE IF.  <a href="#ga54bde32062a405022c4d2881439f61a2">More...</a><br/></td></tr>
<tr class="separator:ga54bde32062a405022c4d2881439f61a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga737bfbad19f05151c1eae5f7f1508893"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#ga737bfbad19f05151c1eae5f7f1508893">XDfeOfdm_SetTuserCCUpdateTrigger</a> (const <a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *InstancePtr, u32 TuserCCUpdateTrigger)</td></tr>
<tr class="memdesc:ga737bfbad19f05151c1eae5f7f1508893"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the TUSER CC Update trigger where bit location would indicate which bit to be used for sending cc update triggering on TUSER (DL_DOUT IF and M_AXIS_TBASE IF).  <a href="#ga737bfbad19f05151c1eae5f7f1508893">More...</a><br/></td></tr>
<tr class="separator:ga737bfbad19f05151c1eae5f7f1508893"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga30994109ba67bcfc2e73f644e422d056"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#ga30994109ba67bcfc2e73f644e422d056">XDfeOfdm_GetTuserCCUpdateTrigger</a> (const <a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga30994109ba67bcfc2e73f644e422d056"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the TUSER CC Update trigger.  <a href="#ga30994109ba67bcfc2e73f644e422d056">More...</a><br/></td></tr>
<tr class="separator:ga30994109ba67bcfc2e73f644e422d056"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3233d744d373a9bd445f462a21af6118"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#ga3233d744d373a9bd445f462a21af6118">XDfeOfdm_SetTUserDelay</a> (const <a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *InstancePtr, u32 Delay)</td></tr>
<tr class="memdesc:ga3233d744d373a9bd445f462a21af6118"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the delay to be added to TUSER and TLAST (delay matched through the IP).  <a href="#ga3233d744d373a9bd445f462a21af6118">More...</a><br/></td></tr>
<tr class="separator:ga3233d744d373a9bd445f462a21af6118"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3f5f28e00b7b56e9ea37d4336543f998"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#ga3f5f28e00b7b56e9ea37d4336543f998">XDfeOfdm_GetTUserDelay</a> (const <a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga3f5f28e00b7b56e9ea37d4336543f998"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads the delay, which will be added to TUSER and TLAST (delay matched through the IP).  <a href="#ga3f5f28e00b7b56e9ea37d4336543f998">More...</a><br/></td></tr>
<tr class="separator:ga3f5f28e00b7b56e9ea37d4336543f998"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7b9560e67cf92d7147e83f67d72f9f6f"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#ga7b9560e67cf92d7147e83f67d72f9f6f">XDfeOfdm_GetDataLatency</a> (const <a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga7b9560e67cf92d7147e83f67d72f9f6f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns data latency.  <a href="#ga7b9560e67cf92d7147e83f67d72f9f6f">More...</a><br/></td></tr>
<tr class="separator:ga7b9560e67cf92d7147e83f67d72f9f6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga95bec20efb52b90b2b6a2d96e51e8989"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#ga95bec20efb52b90b2b6a2d96e51e8989">XDfeOfdm_GetVersions</a> (const <a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *InstancePtr, <a class="el" href="struct_x_dfe_ofdm___version.html">XDfeOfdm_Version</a> *SwVersion, <a class="el" href="struct_x_dfe_ofdm___version.html">XDfeOfdm_Version</a> *HwVersion)</td></tr>
<tr class="memdesc:ga95bec20efb52b90b2b6a2d96e51e8989"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the driver version.  <a href="#ga95bec20efb52b90b2b6a2d96e51e8989">More...</a><br/></td></tr>
<tr class="separator:ga95bec20efb52b90b2b6a2d96e51e8989"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga19ffdc5cb149de0d08af7b2489fb5a0e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#ga19ffdc5cb149de0d08af7b2489fb5a0e">XDfeOfdm_GetEventStatus</a> (const <a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *InstancePtr, <a class="el" href="struct_x_dfe_ofdm___status.html">XDfeOfdm_Status</a> *Status)</td></tr>
<tr class="memdesc:ga19ffdc5cb149de0d08af7b2489fb5a0e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets event status.  <a href="#ga19ffdc5cb149de0d08af7b2489fb5a0e">More...</a><br/></td></tr>
<tr class="separator:ga19ffdc5cb149de0d08af7b2489fb5a0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaba6f602fc482a8c8fd22320d2ba34356"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#gaba6f602fc482a8c8fd22320d2ba34356">XDfeOfdm_ClearEventStatus</a> (const <a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *InstancePtr, const <a class="el" href="struct_x_dfe_ofdm___status.html">XDfeOfdm_Status</a> *Status)</td></tr>
<tr class="memdesc:gaba6f602fc482a8c8fd22320d2ba34356"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears the event status.  <a href="#gaba6f602fc482a8c8fd22320d2ba34356">More...</a><br/></td></tr>
<tr class="separator:gaba6f602fc482a8c8fd22320d2ba34356"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga500a580c416fd8a48cdce2b0844f7206"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#ga500a580c416fd8a48cdce2b0844f7206">XDfeOfdm_SetInterruptMask</a> (const <a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *InstancePtr, const <a class="el" href="struct_x_dfe_ofdm___interrupt_mask.html">XDfeOfdm_InterruptMask</a> *Mask)</td></tr>
<tr class="memdesc:ga500a580c416fd8a48cdce2b0844f7206"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets interrupt masks.  <a href="#ga500a580c416fd8a48cdce2b0844f7206">More...</a><br/></td></tr>
<tr class="separator:ga500a580c416fd8a48cdce2b0844f7206"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa653cb59c46752bf69a87541679ce65f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#gaa653cb59c46752bf69a87541679ce65f">XDfeOfdm_GetInterruptMask</a> (const <a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *InstancePtr, <a class="el" href="struct_x_dfe_ofdm___interrupt_mask.html">XDfeOfdm_InterruptMask</a> *Mask)</td></tr>
<tr class="memdesc:gaa653cb59c46752bf69a87541679ce65f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets interrupt masks.  <a href="#gaa653cb59c46752bf69a87541679ce65f">More...</a><br/></td></tr>
<tr class="separator:gaa653cb59c46752bf69a87541679ce65f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6d938668e6e1b73a585775cbe0eab471"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#ga6d938668e6e1b73a585775cbe0eab471">XDfeOfdm_AddCCExample</a> ()</td></tr>
<tr class="memdesc:ga6d938668e6e1b73a585775cbe0eab471"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function runs the DFE OFDM device using the driver APIs.  <a href="#ga6d938668e6e1b73a585775cbe0eab471">More...</a><br/></td></tr>
<tr class="separator:ga6d938668e6e1b73a585775cbe0eab471"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf304555910bc042c2de8437ac0b448d3"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__dfeofdm.html#gaf304555910bc042c2de8437ac0b448d3">XDfeOfdm_MultiAddCCExample</a> ()</td></tr>
<tr class="memdesc:gaf304555910bc042c2de8437ac0b448d3"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function runs the DFE OFDM device using the driver APIs.  <a href="#gaf304555910bc042c2de8437ac0b448d3">More...</a><br/></td></tr>
<tr class="separator:gaf304555910bc042c2de8437ac0b448d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga73fef423ca0f5af468481c7093d8c2ce"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XDFEOFDM_BASEADDR_PROPERTY&#160;&#160;&#160;&quot;reg&quot;</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Base address property. </p>

</div>
</div>
<a class="anchor" id="ga9674335dc9b55ab380ef815fcea351af"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XDFEOFDM_BASEADDR_SIZE&#160;&#160;&#160;8U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Base address bit-size. </p>

</div>
</div>
<a class="anchor" id="gaaa0a15327eb2c47371a1161d42d97a48"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XDFEOFDM_BUS_NAME&#160;&#160;&#160;&quot;platform&quot;</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>System bus name. </p>

</div>
</div>
<a class="anchor" id="gab8b2ac9b5c081fc45107e1e5f682b157"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XDFEOFDM_CC_NUM&#160;&#160;&#160;(16)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Maximum CC sequence number. </p>

<p>Referenced by <a class="el" href="group__dfeofdm.html#ga895d37558bb4351d118f1970d79a2d7b">XDfeOfdm_GetCurrentCCCfg()</a>, <a class="el" href="group__dfeofdm.html#ga0f253b33e1be8d4b37bbddf681669a13">XDfeOfdm_GetEmptyCCCfg()</a>, and <a class="el" href="group__dfeofdm.html#gaef40749e07cdc3a4a00a2e8228d5d8b8">XDfeOfdm_SetNextCCCfg()</a>.</p>

</div>
</div>
<a class="anchor" id="gae1b70fbbb2d556355abe4fb78ee9a1ee"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XDFEOFDM_CC_SEQ_LENGTH_MAX&#160;&#160;&#160;(16U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Maximum sequence length. </p>

<p>Referenced by <a class="el" href="group__dfeofdm.html#gaef40749e07cdc3a4a00a2e8228d5d8b8">XDfeOfdm_SetNextCCCfg()</a>.</p>

</div>
</div>
<a class="anchor" id="gae6de2b2534061e81fb5cfde6c33e36e7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XDFEOFDM_COMPATIBLE_PROPERTY&#160;&#160;&#160;&quot;compatible&quot;</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Device tree property. </p>

</div>
</div>
<a class="anchor" id="gac0365d88ff2b68ab1265a08ced0b8c3e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XDFEOFDM_COMPATIBLE_STRING&#160;&#160;&#160;&quot;xlnx,xdfe-ofdm-2.2&quot;</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Device name property. </p>

</div>
</div>
<a class="anchor" id="ga7a63606234dc8bb5e3ecfc374ec08fcb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XDFEOFDM_COMPATIBLE_STRING_2_1&#160;&#160;&#160;&quot;xlnx,xdfe-ofdm-2.1&quot;</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Device name property. </p>

</div>
</div>
<a class="anchor" id="gaca6bdd93682f011cf7af49604858e6c4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XDFEOFDM_DRIVER_VERSION_MAJOR&#160;&#160;&#160;(1U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Major version number of driver. </p>

<p>Referenced by <a class="el" href="group__dfeofdm.html#ga95bec20efb52b90b2b6a2d96e51e8989">XDfeOfdm_GetVersions()</a>.</p>

</div>
</div>
<a class="anchor" id="gab4ee35983c0d92285d640affefc3dcad"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XDFEOFDM_DRIVER_VERSION_MINOR&#160;&#160;&#160;(3U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Minor version number of driver. </p>

<p>Referenced by <a class="el" href="group__dfeofdm.html#ga95bec20efb52b90b2b6a2d96e51e8989">XDfeOfdm_GetVersions()</a>.</p>

</div>
</div>
<a class="anchor" id="ga37d661eaba3931cc94c8e2f3bdef2775"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XDFEOFDM_FREQUENCY_RANGE_1&#160;&#160;&#160;0U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>[15, 30, 60] kHz (default) </p>

</div>
</div>
<a class="anchor" id="ga0f37ddff73e8d1fa275d44da5803846e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XDFEOFDM_FREQUENCY_RANGE_2&#160;&#160;&#160;1U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>[60, 120, 240, 480, 960] kHz </p>

</div>
</div>
<a class="anchor" id="ga9f3b3e7ef1ded7f8fdb9019cc06945c7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XDFEOFDM_FT_NUM&#160;&#160;&#160;(16)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Maximum FT sequence number. </p>

<p>Referenced by <a class="el" href="group__dfeofdm.html#gaef40749e07cdc3a4a00a2e8228d5d8b8">XDfeOfdm_SetNextCCCfg()</a>.</p>

</div>
</div>
<a class="anchor" id="gad235a4fa132b4f4c9beb9cfee8ddce9e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XDFEOFDM_FT_SEQ_LENGTH_MAX&#160;&#160;&#160;(16U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Maximum Fourier transform sequence length. </p>

</div>
</div>
<a class="anchor" id="gac89bab3faf02d647cf50864711fcde4e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XDFEOFDM_INSTANCE_EXISTS</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">X</td><td>)</td>
          <td>&#160;&#160;&#160;(X &lt; <a class="el" href="group__dfeofdm.html#ga845d4be1302f35864f7c53001bb4d793">XDFEOFDM_MAX_NUM_INSTANCES</a>)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Number of instances that exist at any given time. </p>

<p>Referenced by <a class="el" href="group__dfeofdm.html#ga765082b84acafa5bcef9c2ad92bb7cf6">XDfeOfdm_InstanceClose()</a>, and <a class="el" href="group__dfeofdm.html#ga432a6579323bb9a5ec591489ffc2ac0f">XDfeOfdm_InstanceInit()</a>.</p>

</div>
</div>
<a class="anchor" id="ga845d4be1302f35864f7c53001bb4d793"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XDFEOFDM_MAX_NUM_INSTANCES&#160;&#160;&#160;(10U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Maximum number of driver instances running at the same time. </p>

</div>
</div>
<a class="anchor" id="ga2b1ba159bec0d962b41efafc034d2eae"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XDFEOFDM_NODE_NAME_MAX_LENGTH&#160;&#160;&#160;(50U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Node name maximum length. </p>

<p>Referenced by <a class="el" href="group__dfeofdm.html#ga432a6579323bb9a5ec591489ffc2ac0f">XDfeOfdm_InstanceInit()</a>.</p>

</div>
</div>
<a class="anchor" id="ga8781db2b27a846747e58ff160bea6751"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XDFEOFDM_PHASE_COMPENSATION_MAX&#160;&#160;&#160;(112U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Maximum phase compensation weight. </p>

<p>Referenced by <a class="el" href="group__dfeofdm.html#gade552f0bcf5ed9eac51ca4fcc4b983fa">XDfeOfdm_AddCCtoCCCfg()</a>, and <a class="el" href="group__dfeofdm.html#ga38d91645f0bc01f170a6333fb22f47cd">XDfeOfdm_UpdateCCinCCCfg()</a>.</p>

</div>
</div>
<a class="anchor" id="gae4d82a1199fcbbeff474569c036edeac"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XDFEOFDM_PHASE_COMPENSATION_REG_STEP&#160;&#160;&#160;8U</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Address space step between space for phase compensation on one carrier. </p>

</div>
</div>
<a class="anchor" id="gac19ea8ab6170b162ac40927cc7002254"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XDFEOFDM_PLATFORM_DEVICE_DIR&#160;&#160;&#160;&quot;/sys/bus/platform/devices/&quot;</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Device location in a file system. </p>

</div>
</div>
<a class="anchor" id="ga9478d2b97aa40e09052dee2571940ef9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XST_FAILURE&#160;&#160;&#160;(1U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Failure flag. </p>

<p>Referenced by <a class="el" href="xdfeofdm__examples_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main()</a>, <a class="el" href="group__dfeofdm.html#ga6d938668e6e1b73a585775cbe0eab471">XDfeOfdm_AddCCExample()</a>, <a class="el" href="group__dfeofdm.html#gade552f0bcf5ed9eac51ca4fcc4b983fa">XDfeOfdm_AddCCtoCCCfg()</a>, <a class="el" href="group__dfeofdm.html#gac49b03eaed4ce4083b5d51650a121158">XDfeOfdm_EnableCCUpdateTrigger()</a>, <a class="el" href="group__dfeofdm.html#ga432a6579323bb9a5ec591489ffc2ac0f">XDfeOfdm_InstanceInit()</a>, <a class="el" href="group__dfeofdm.html#gaf304555910bc042c2de8437ac0b448d3">XDfeOfdm_MultiAddCCExample()</a>, <a class="el" href="group__dfeofdm.html#ga030e66a15c8f0c1b4493aa605dca2c30">XDfeOfdm_RemoveCCfromCCCfg()</a>, <a class="el" href="group__dfeofdm.html#ga38d91645f0bc01f170a6333fb22f47cd">XDfeOfdm_UpdateCCinCCCfg()</a>, and <a class="el" href="xdfeofdm__examples_8c.html#a0ddb0f8ca495eb4e99eabc79fc0d41d1">XDfeSi570_SetMgtOscillator()</a>.</p>

</div>
</div>
<a class="anchor" id="ga959ffc15251ddc9b3a883a30f97b7715"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XST_SUCCESS&#160;&#160;&#160;(0U)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Success flag. </p>

<p>Referenced by <a class="el" href="xdfeofdm__examples_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main()</a>, <a class="el" href="group__dfeofdm.html#ga6d938668e6e1b73a585775cbe0eab471">XDfeOfdm_AddCCExample()</a>, <a class="el" href="group__dfeofdm.html#gade552f0bcf5ed9eac51ca4fcc4b983fa">XDfeOfdm_AddCCtoCCCfg()</a>, <a class="el" href="group__dfeofdm.html#gac49b03eaed4ce4083b5d51650a121158">XDfeOfdm_EnableCCUpdateTrigger()</a>, <a class="el" href="group__dfeofdm.html#ga432a6579323bb9a5ec591489ffc2ac0f">XDfeOfdm_InstanceInit()</a>, <a class="el" href="group__dfeofdm.html#gaf304555910bc042c2de8437ac0b448d3">XDfeOfdm_MultiAddCCExample()</a>, <a class="el" href="group__dfeofdm.html#ga030e66a15c8f0c1b4493aa605dca2c30">XDfeOfdm_RemoveCCfromCCCfg()</a>, <a class="el" href="group__dfeofdm.html#ga38d91645f0bc01f170a6333fb22f47cd">XDfeOfdm_UpdateCCinCCCfg()</a>, and <a class="el" href="xdfeofdm__examples_8c.html#a0ddb0f8ca495eb4e99eabc79fc0d41d1">XDfeSi570_SetMgtOscillator()</a>.</p>

</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="ga8fe9073be4e4298b7c4bf8fe8c565b2a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__dfeofdm.html#ga8fe9073be4e4298b7c4bf8fe8c565b2a">XDfeOfdm_StateId</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga8fe9073be4e4298b7c4bf8fe8c565b2aa18fda0537eb680a4d71a6565095c1b1a"></a>XDFEOFDM_STATE_NOT_READY</em>&nbsp;</td><td class="fielddoc">
<p>Not ready state. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga8fe9073be4e4298b7c4bf8fe8c565b2aa56db899ae9d39e13af58ecb472ef9448"></a>XDFEOFDM_STATE_READY</em>&nbsp;</td><td class="fielddoc">
<p>Ready state. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga8fe9073be4e4298b7c4bf8fe8c565b2aa4bb607567495464ddbb620d55a620509"></a>XDFEOFDM_STATE_RESET</em>&nbsp;</td><td class="fielddoc">
<p>Reset state. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga8fe9073be4e4298b7c4bf8fe8c565b2aa80209d129faeae7e529b68c3927db3cf"></a>XDFEOFDM_STATE_CONFIGURED</em>&nbsp;</td><td class="fielddoc">
<p>Configured state. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga8fe9073be4e4298b7c4bf8fe8c565b2aa697df6f5fef047d5a215f24b86203c04"></a>XDFEOFDM_STATE_INITIALISED</em>&nbsp;</td><td class="fielddoc">
<p>Initialized state. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga8fe9073be4e4298b7c4bf8fe8c565b2aab5e131c361e68b90e4351670b9b6ec85"></a>XDFEOFDM_STATE_OPERATIONAL</em>&nbsp;</td><td class="fielddoc">
<p>Operational state. </p>
</td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga17cc3a5b3f29a0dc0065018d0fe3ec98"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XDfeOfdm_Activate </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>EnableLowPower</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Activates OFDM and moves the state machine to an activated state. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the OFDM instance. </td></tr>
    <tr><td class="paramname">EnableLowPower</td><td>Flag indicating low power. </td></tr>
  </table>
  </dd>
</dl>

<p>References <a class="el" href="struct_x_dfe_ofdm.html#a1e567a49d18d5f25268062a28bb0e7a4">XDfeOfdm::StateId</a>, <a class="el" href="group__dfeofdm.html#gga8fe9073be4e4298b7c4bf8fe8c565b2aa697df6f5fef047d5a215f24b86203c04">XDFEOFDM_STATE_INITIALISED</a>, and <a class="el" href="group__dfeofdm.html#gga8fe9073be4e4298b7c4bf8fe8c565b2aab5e131c361e68b90e4351670b9b6ec85">XDFEOFDM_STATE_OPERATIONAL</a>.</p>

<p>Referenced by <a class="el" href="group__dfeofdm.html#ga6d938668e6e1b73a585775cbe0eab471">XDfeOfdm_AddCCExample()</a>, and <a class="el" href="group__dfeofdm.html#gaf304555910bc042c2de8437ac0b448d3">XDfeOfdm_MultiAddCCExample()</a>.</p>

</div>
</div>
<a class="anchor" id="ga6d938668e6e1b73a585775cbe0eab471"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XDfeOfdm_AddCCExample </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function runs the DFE OFDM device using the driver APIs. </p>
<p>This function does the following tasks:</p>
<ul>
<li>Create and system initialize the device driver instance.</li>
<li>Read SW and HW version numbers.</li>
<li>Reset the device.</li>
<li>Configure the device.</li>
<li>Initialize the device.</li>
<li>Set the triggers</li>
<li>Activate the device.</li>
<li>Add CC.</li>
<li>DeActivate the device.</li>
</ul>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if the example has completed successfully.</li>
<li>XST_FAILURE if the example has failed.//! [testexample1] </li>
</ul>
</dd></dl>

<p>References <a class="el" href="struct_x_dfe_ofdm___trigger_cfg.html#aa57868c1544ac36a8c3c0df957280b3f">XDfeOfdm_TriggerCfg::Activate</a>, <a class="el" href="struct_x_dfe_ofdm___model_parameters.html#ab3eea5fdd0f6aef6e40b19c2a4e9f87a">XDfeOfdm_ModelParameters::AntennaInterleave</a>, <a class="el" href="struct_x_dfe_ofdm___config.html#a7019e60230034c910288a2a3e2523884">XDfeOfdm_Config::AntennaInterleave</a>, <a class="el" href="struct_x_dfe_ofdm___config.html#a000fe7aff8b1a94854d52906b74516e9">XDfeOfdm_Config::BaseAddr</a>, <a class="el" href="struct_x_dfe_ofdm___init.html#a442ea1755b41de1b2b2b8dec54c638f3">XDfeOfdm_Init::CCSequenceLength</a>, <a class="el" href="struct_x_dfe_ofdm___trigger_cfg.html#aa18f8fff86f7d41df716d87e6332665f">XDfeOfdm_TriggerCfg::CCUpdate</a>, <a class="el" href="struct_x_dfe_ofdm___status.html#acf8828edf030249444e48a6ddba48600">XDfeOfdm_Status::CCUpdate</a>, <a class="el" href="struct_x_dfe_ofdm___carrier_cfg.html#a686973c0ebb9efea76c75f12c751c797">XDfeOfdm_CarrierCfg::CommsStandard</a>, <a class="el" href="struct_x_dfe_ofdm.html#a8400ce059751b5bc46dbce6cf9cc8e3f">XDfeOfdm::Config</a>, <a class="el" href="struct_x_dfe_ofdm___carrier_cfg.html#a28c3b141657d28642106a2dc91ccba60">XDfeOfdm_CarrierCfg::FftSize</a>, <a class="el" href="struct_x_dfe_ofdm___status.html#a44d833d3eb4c76c14f844e3e3b3b8b4a">XDfeOfdm_Status::FTCCSequenceError</a>, <a class="el" href="struct_x_dfe_ofdm___f_t_sequence.html#a1c5d8cfef8f5dbaff69b2a110bc6b9f9">XDfeOfdm_FTSequence::Length</a>, <a class="el" href="struct_x_dfe_ofdm___version.html#a9aa2f3a5d250912399f20e9e781c085b">XDfeOfdm_Version::Major</a>, <a class="el" href="struct_x_dfe_ofdm___version.html#af5fcebc75c34601d4a802e10cce5409c">XDfeOfdm_Version::Minor</a>, <a class="el" href="struct_x_dfe_ofdm___trigger.html#a7588c100fa85f1c3921c785dc949577b">XDfeOfdm_Trigger::Mode</a>, <a class="el" href="struct_x_dfe_ofdm___cfg.html#a38c1c79086484df53f2f1a6285f2d9f8">XDfeOfdm_Cfg::ModelParams</a>, <a class="el" href="struct_x_dfe_ofdm.html#a13700eb62a7a5d65decb22b291f09edb">XDfeOfdm::NodeName</a>, <a class="el" href="struct_x_dfe_ofdm___model_parameters.html#adc43d413c0fb6208c2e5562f4b33f157">XDfeOfdm_ModelParameters::NumAntenna</a>, <a class="el" href="struct_x_dfe_ofdm___config.html#aaa5d6fa86588a75218cd3cd5562c2353">XDfeOfdm_Config::NumAntenna</a>, <a class="el" href="struct_x_dfe_ofdm___carrier_cfg.html#a9c5b2618474f9abfff97ce4d6cb8e04a">XDfeOfdm_CarrierCfg::Numerology</a>, <a class="el" href="struct_x_dfe_ofdm___carrier_cfg.html#a8e89be7280a23bf544fe02ea64627477">XDfeOfdm_CarrierCfg::NumSubcarriers</a>, <a class="el" href="struct_x_dfe_ofdm___carrier_cfg.html#a5df249fedf2fba3dd80b9f25815a69db">XDfeOfdm_CarrierCfg::OutputDelay</a>, <a class="el" href="struct_x_dfe_ofdm___version.html#a07307e027316a832b6234574fc99383f">XDfeOfdm_Version::Patch</a>, <a class="el" href="struct_x_dfe_ofdm___version.html#a253dc76cd0f291a746d1daac0ae53486">XDfeOfdm_Version::Revision</a>, <a class="el" href="struct_x_dfe_ofdm___status.html#aace4b8584b3e30af0f4665953329bb93">XDfeOfdm_Status::Saturation</a>, <a class="el" href="struct_x_dfe_ofdm___status.html#adf029f9a8749eeb0e32c7b746862cc6d">XDfeOfdm_Status::SaturationCCID</a>, <a class="el" href="struct_x_dfe_ofdm___status.html#aa08cdef43e5dee673925674a92cd8512">XDfeOfdm_Status::SaturationCount</a>, <a class="el" href="struct_x_dfe_ofdm___carrier_cfg.html#a5e7eccd516549e6547c4881c74bf578c">XDfeOfdm_CarrierCfg::ScaleFactor</a>, <a class="el" href="struct_x_dfe_ofdm___trigger.html#a08962b0f9f87949435bb7d06891bc00f">XDfeOfdm_Trigger::TUSERBit</a>, <a class="el" href="struct_x_dfe_ofdm___trigger.html#afa7f0e1385ceb726bc0675cdbe6afc8f">XDfeOfdm_Trigger::TuserEdgeLevel</a>, <a class="el" href="struct_x_dfe_ofdm___cfg.html#ad9d93d7772122b3375effab5910358a5">XDfeOfdm_Cfg::Version</a>, <a class="el" href="group__dfeofdm.html#ga17cc3a5b3f29a0dc0065018d0fe3ec98">XDfeOfdm_Activate()</a>, <a class="el" href="group__dfeofdm.html#gaba6f602fc482a8c8fd22320d2ba34356">XDfeOfdm_ClearEventStatus()</a>, <a class="el" href="group__dfeofdm.html#ga8248b6bc1f2f9dd0f5b2a04c62062753">XDfeOfdm_Configure()</a>, <a class="el" href="group__dfeofdm.html#ga8c3460b747d8e053c0bcb66a36b1a827">XDfeOfdm_Deactivate()</a>, <a class="el" href="group__dfeofdm.html#ga95bec20efb52b90b2b6a2d96e51e8989">XDfeOfdm_GetVersions()</a>, <a class="el" href="group__dfeofdm.html#ga01a406ff1a9f5562ee5fc7c7a28ea237">XDfeOfdm_Initialize()</a>, <a class="el" href="group__dfeofdm.html#ga765082b84acafa5bcef9c2ad92bb7cf6">XDfeOfdm_InstanceClose()</a>, <a class="el" href="group__dfeofdm.html#ga432a6579323bb9a5ec591489ffc2ac0f">XDfeOfdm_InstanceInit()</a>, <a class="el" href="group__dfeofdm.html#ga337fe11e6ef1bef0727ba3b9ee59b10f">XDfeOfdm_Reset()</a>, <a class="el" href="group__dfeofdm.html#ga5e4d810d0e04bbad650fbb60115254e4">XDfeOfdm_SetTriggersCfg()</a>, <a class="el" href="group__dfeofdm.html#ga9478d2b97aa40e09052dee2571940ef9">XST_FAILURE</a>, and <a class="el" href="group__dfeofdm.html#ga959ffc15251ddc9b3a883a30f97b7715">XST_SUCCESS</a>.</p>

<p>Referenced by <a class="el" href="xdfeofdm__examples_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main()</a>.</p>

</div>
</div>
<a class="anchor" id="gade552f0bcf5ed9eac51ca4fcc4b983fa"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XDfeOfdm_AddCCtoCCCfg </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_dfe_ofdm___c_c_cfg.html">XDfeOfdm_CCCfg</a> *&#160;</td>
          <td class="paramname"><em>CCCfg</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">s32&#160;</td>
          <td class="paramname"><em>CCID</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>CCSeqBitmap</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="struct_x_dfe_ofdm___carrier_cfg.html">XDfeOfdm_CarrierCfg</a> *&#160;</td>
          <td class="paramname"><em>CarrierCfg</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_dfe_ofdm___f_t_sequence.html">XDfeOfdm_FTSequence</a> *&#160;</td>
          <td class="paramname"><em>FTSeq</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Adds specified CCID, with specified configuration, to a local CC configuration structure. </p>
<p>If there is insufficient capacity for the new CC the function will return an error. Initiates CC update (enable CCUpdate trigger TUSER Single Shot).</p>
<p>The returned CCCfg.CCSequence is translated as there is no explicit indication that SEQUENCE[i] is not used - 0 can define the slot as either used or not used. Sequence data that is returned in the CCIDSequence is not the same as what is written in the registers. The translation is:</p>
<ul>
<li>CCIDSequence.CCID[i] = -1 - if [i] is unused slot</li>
<li>CCIDSequence.CCID[i] = CCID - if [i] is used slot</li>
<li>A returned CCIDSequence-&gt;Length = length in register + 1</li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the OFDM instance. </td></tr>
    <tr><td class="paramname">CCCfg</td><td>Component carrier (CC) configuration container. </td></tr>
    <tr><td class="paramname">CCID</td><td>CC ID. </td></tr>
    <tr><td class="paramname">CCSeqBitmap</td><td>CC slot position container. </td></tr>
    <tr><td class="paramname">CarrierCfg</td><td>CC configuration container. </td></tr>
    <tr><td class="paramname">FTSeq</td><td>Fourier transform sequence container.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if successful.</li>
<li>XST_FAILURE if error occurs. </li>
</ul>
</dd></dl>

<p>References <a class="el" href="struct_x_dfe_ofdm___c_c_cfg.html#af8215954862eaa1ceb1cdf785003abb5">XDfeOfdm_CCCfg::CarrierCfg</a>, <a class="el" href="struct_x_dfe_ofdm___c_c_cfg.html#a76a6f2071855ae642f660f362342666e">XDfeOfdm_CCCfg::CCSequence</a>, <a class="el" href="struct_x_dfe_ofdm___carrier_cfg.html#a686973c0ebb9efea76c75f12c751c797">XDfeOfdm_CarrierCfg::CommsStandard</a>, <a class="el" href="struct_x_dfe_ofdm___internal_carrier_cfg.html#a2be0adf2857f6b06b6b016fea30a8d34">XDfeOfdm_InternalCarrierCfg::CommsStandard</a>, <a class="el" href="struct_x_dfe_ofdm___internal_carrier_cfg.html#ad7d569669e17596881cc055545c38334">XDfeOfdm_InternalCarrierCfg::Enable</a>, <a class="el" href="struct_x_dfe_ofdm___carrier_cfg.html#a28c3b141657d28642106a2dc91ccba60">XDfeOfdm_CarrierCfg::FftSize</a>, <a class="el" href="struct_x_dfe_ofdm___internal_carrier_cfg.html#a1b001fa194a4d3fe13c200a4f491324e">XDfeOfdm_InternalCarrierCfg::FftSize</a>, <a class="el" href="struct_x_dfe_ofdm___f_t_sequence.html#a1c5d8cfef8f5dbaff69b2a110bc6b9f9">XDfeOfdm_FTSequence::Length</a>, <a class="el" href="struct_x_dfe_ofdm___carrier_cfg.html#a9c5b2618474f9abfff97ce4d6cb8e04a">XDfeOfdm_CarrierCfg::Numerology</a>, <a class="el" href="struct_x_dfe_ofdm___internal_carrier_cfg.html#af5a13d6f57aadd11848a84273fd57046">XDfeOfdm_InternalCarrierCfg::Numerology</a>, <a class="el" href="struct_x_dfe_ofdm___carrier_cfg.html#a8e89be7280a23bf544fe02ea64627477">XDfeOfdm_CarrierCfg::NumSubcarriers</a>, <a class="el" href="struct_x_dfe_ofdm___internal_carrier_cfg.html#a6c1777dfb0d4cc4573474a717cc58c98">XDfeOfdm_InternalCarrierCfg::NumSubcarriers</a>, <a class="el" href="struct_x_dfe_ofdm___carrier_cfg.html#a5df249fedf2fba3dd80b9f25815a69db">XDfeOfdm_CarrierCfg::OutputDelay</a>, <a class="el" href="struct_x_dfe_ofdm___carrier_cfg.html#aa428f3c890556622538228163b94e266">XDfeOfdm_CarrierCfg::PhaseCompensation</a>, <a class="el" href="struct_x_dfe_ofdm___internal_carrier_cfg.html#a2162ce8645de30643f71dcd6daeaae15">XDfeOfdm_InternalCarrierCfg::PhaseCompensation</a>, <a class="el" href="struct_x_dfe_ofdm___carrier_cfg.html#a5e7eccd516549e6547c4881c74bf578c">XDfeOfdm_CarrierCfg::ScaleFactor</a>, <a class="el" href="struct_x_dfe_ofdm___internal_carrier_cfg.html#ad9ec683d3980800f0a067b0e329f749c">XDfeOfdm_InternalCarrierCfg::ScaleFactor</a>, <a class="el" href="group__dfeofdm.html#ga8781db2b27a846747e58ff160bea6751">XDFEOFDM_PHASE_COMPENSATION_MAX</a>, <a class="el" href="group__dfeofdm.html#ga9478d2b97aa40e09052dee2571940ef9">XST_FAILURE</a>, and <a class="el" href="group__dfeofdm.html#ga959ffc15251ddc9b3a883a30f97b7715">XST_SUCCESS</a>.</p>

<p>Referenced by <a class="el" href="group__dfeofdm.html#gaf304555910bc042c2de8437ac0b448d3">XDfeOfdm_MultiAddCCExample()</a>.</p>

</div>
</div>
<a class="anchor" id="gaba6f602fc482a8c8fd22320d2ba34356"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XDfeOfdm_ClearEventStatus </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="struct_x_dfe_ofdm___status.html">XDfeOfdm_Status</a> *&#160;</td>
          <td class="paramname"><em>Status</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Clears the event status. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the OFDM instance. </td></tr>
    <tr><td class="paramname">Status</td><td>Clear event status container.<ul>
<li>0 - Does not clear the corresponding event status</li>
<li>1 - Clears the corresponding event status </li>
</ul>
</td></tr>
  </table>
  </dd>
</dl>

<p>References <a class="el" href="struct_x_dfe_ofdm___status.html#acf8828edf030249444e48a6ddba48600">XDfeOfdm_Status::CCUpdate</a>, <a class="el" href="struct_x_dfe_ofdm___status.html#a44d833d3eb4c76c14f844e3e3b3b8b4a">XDfeOfdm_Status::FTCCSequenceError</a>, <a class="el" href="struct_x_dfe_ofdm___status.html#aa2c11c23eceeae6341234d06c19edce8">XDfeOfdm_Status::Overflow</a>, and <a class="el" href="struct_x_dfe_ofdm___status.html#aace4b8584b3e30af0f4665953329bb93">XDfeOfdm_Status::Saturation</a>.</p>

<p>Referenced by <a class="el" href="group__dfeofdm.html#ga6d938668e6e1b73a585775cbe0eab471">XDfeOfdm_AddCCExample()</a>, and <a class="el" href="group__dfeofdm.html#gaf304555910bc042c2de8437ac0b448d3">XDfeOfdm_MultiAddCCExample()</a>.</p>

</div>
</div>
<a class="anchor" id="ga8248b6bc1f2f9dd0f5b2a04c62062753"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XDfeOfdm_Configure </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_dfe_ofdm___cfg.html">XDfeOfdm_Cfg</a> *&#160;</td>
          <td class="paramname"><em>Cfg</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reads configuration from device tree/xparameters.h and IP registers. </p>
<p>Removes the S/W reset and moves the state machine to a configured state.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the OFDM instance. </td></tr>
    <tr><td class="paramname">Cfg</td><td>Configuration data container. </td></tr>
  </table>
  </dd>
</dl>

<p>References <a class="el" href="struct_x_dfe_ofdm___model_parameters.html#ab3eea5fdd0f6aef6e40b19c2a4e9f87a">XDfeOfdm_ModelParameters::AntennaInterleave</a>, <a class="el" href="struct_x_dfe_ofdm___config.html#a7019e60230034c910288a2a3e2523884">XDfeOfdm_Config::AntennaInterleave</a>, <a class="el" href="struct_x_dfe_ofdm.html#a8400ce059751b5bc46dbce6cf9cc8e3f">XDfeOfdm::Config</a>, <a class="el" href="struct_x_dfe_ofdm___config.html#a9b9f48c96d0b75d2fb10de3b22f946f1">XDfeOfdm_Config::FrequencyRange</a>, <a class="el" href="struct_x_dfe_ofdm___version.html#a9aa2f3a5d250912399f20e9e781c085b">XDfeOfdm_Version::Major</a>, <a class="el" href="struct_x_dfe_ofdm___version.html#af5fcebc75c34601d4a802e10cce5409c">XDfeOfdm_Version::Minor</a>, <a class="el" href="struct_x_dfe_ofdm___cfg.html#a38c1c79086484df53f2f1a6285f2d9f8">XDfeOfdm_Cfg::ModelParams</a>, <a class="el" href="struct_x_dfe_ofdm___model_parameters.html#adc43d413c0fb6208c2e5562f4b33f157">XDfeOfdm_ModelParameters::NumAntenna</a>, <a class="el" href="struct_x_dfe_ofdm___config.html#aaa5d6fa86588a75218cd3cd5562c2353">XDfeOfdm_Config::NumAntenna</a>, <a class="el" href="struct_x_dfe_ofdm___version.html#a07307e027316a832b6234574fc99383f">XDfeOfdm_Version::Patch</a>, <a class="el" href="struct_x_dfe_ofdm___model_parameters.html#a6a8b4558e597f67f99f88b09b6ee50d6">XDfeOfdm_ModelParameters::PhaseCompensation</a>, <a class="el" href="struct_x_dfe_ofdm___config.html#a229f0f20ed45912dbd01cb87341ab877">XDfeOfdm_Config::PhaseCompensation</a>, <a class="el" href="struct_x_dfe_ofdm___version.html#a253dc76cd0f291a746d1daac0ae53486">XDfeOfdm_Version::Revision</a>, <a class="el" href="struct_x_dfe_ofdm.html#a1e567a49d18d5f25268062a28bb0e7a4">XDfeOfdm::StateId</a>, <a class="el" href="struct_x_dfe_ofdm___cfg.html#ad9d93d7772122b3375effab5910358a5">XDfeOfdm_Cfg::Version</a>, <a class="el" href="group__dfeofdm.html#gga8fe9073be4e4298b7c4bf8fe8c565b2aa80209d129faeae7e529b68c3927db3cf">XDFEOFDM_STATE_CONFIGURED</a>, and <a class="el" href="group__dfeofdm.html#gga8fe9073be4e4298b7c4bf8fe8c565b2aa4bb607567495464ddbb620d55a620509">XDFEOFDM_STATE_RESET</a>.</p>

<p>Referenced by <a class="el" href="group__dfeofdm.html#ga6d938668e6e1b73a585775cbe0eab471">XDfeOfdm_AddCCExample()</a>, and <a class="el" href="group__dfeofdm.html#gaf304555910bc042c2de8437ac0b448d3">XDfeOfdm_MultiAddCCExample()</a>.</p>

</div>
</div>
<a class="anchor" id="ga8c3460b747d8e053c0bcb66a36b1a827"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XDfeOfdm_Deactivate </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Deactivates OFDM and moves the state machine to an initialised state. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the OFDM instance. </td></tr>
  </table>
  </dd>
</dl>

<p>References <a class="el" href="struct_x_dfe_ofdm.html#a1e567a49d18d5f25268062a28bb0e7a4">XDfeOfdm::StateId</a>, <a class="el" href="group__dfeofdm.html#gga8fe9073be4e4298b7c4bf8fe8c565b2aa697df6f5fef047d5a215f24b86203c04">XDFEOFDM_STATE_INITIALISED</a>, and <a class="el" href="group__dfeofdm.html#gga8fe9073be4e4298b7c4bf8fe8c565b2aab5e131c361e68b90e4351670b9b6ec85">XDFEOFDM_STATE_OPERATIONAL</a>.</p>

<p>Referenced by <a class="el" href="group__dfeofdm.html#ga6d938668e6e1b73a585775cbe0eab471">XDfeOfdm_AddCCExample()</a>, and <a class="el" href="group__dfeofdm.html#gaf304555910bc042c2de8437ac0b448d3">XDfeOfdm_MultiAddCCExample()</a>.</p>

</div>
</div>
<a class="anchor" id="gac49b03eaed4ce4083b5d51650a121158"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XDfeOfdm_EnableCCUpdateTrigger </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reads the triggers and sets the enable bit of Update trigger. </p>
<p>If Mode = IMMEDIATE, the trigger will be applied immediately.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the OFDM instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if successful.</li>
<li>XST_FAILURE if error occurs. </li>
</ul>
</dd></dl>

<p>References <a class="el" href="group__dfeofdm.html#ga9478d2b97aa40e09052dee2571940ef9">XST_FAILURE</a>, and <a class="el" href="group__dfeofdm.html#ga959ffc15251ddc9b3a883a30f97b7715">XST_SUCCESS</a>.</p>

<p>Referenced by <a class="el" href="group__dfeofdm.html#ga9daeab383fd324e6812ae53d248ceeaa">XDfeOfdm_SetNextCCCfgAndTrigger()</a>.</p>

</div>
</div>
<a class="anchor" id="gaa9f6889b400fc2fcd705f0760c6fa696"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XDfeOfdm_GetCarrierCfg </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_dfe_ofdm___c_c_cfg.html">XDfeOfdm_CCCfg</a> *&#160;</td>
          <td class="paramname"><em>CCCfg</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">s32&#160;</td>
          <td class="paramname"><em>CCID</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32 *&#160;</td>
          <td class="paramname"><em>CCSeqBitmap</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_dfe_ofdm___carrier_cfg.html">XDfeOfdm_CarrierCfg</a> *&#160;</td>
          <td class="paramname"><em>CarrierCfg</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the current CCID carrier configuration. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the OFDM instance. </td></tr>
    <tr><td class="paramname">CCCfg</td><td>Component carrier (CC) configuration container. </td></tr>
    <tr><td class="paramname">CCID</td><td>CC ID. </td></tr>
    <tr><td class="paramname">CCSeqBitmap</td><td>CC slot position container. </td></tr>
    <tr><td class="paramname">CarrierCfg</td><td>CC configuration container. </td></tr>
  </table>
  </dd>
</dl>

<p>References <a class="el" href="struct_x_dfe_ofdm___c_c_cfg.html#af8215954862eaa1ceb1cdf785003abb5">XDfeOfdm_CCCfg::CarrierCfg</a>, <a class="el" href="struct_x_dfe_ofdm___c_c_sequence.html#aaab78fa8bb86d61092ca378481dabe8b">XDfeOfdm_CCSequence::CCID</a>, <a class="el" href="struct_x_dfe_ofdm___c_c_cfg.html#a76a6f2071855ae642f660f362342666e">XDfeOfdm_CCCfg::CCSequence</a>, <a class="el" href="struct_x_dfe_ofdm___carrier_cfg.html#a686973c0ebb9efea76c75f12c751c797">XDfeOfdm_CarrierCfg::CommsStandard</a>, <a class="el" href="struct_x_dfe_ofdm___internal_carrier_cfg.html#a2be0adf2857f6b06b6b016fea30a8d34">XDfeOfdm_InternalCarrierCfg::CommsStandard</a>, <a class="el" href="struct_x_dfe_ofdm___carrier_cfg.html#a28c3b141657d28642106a2dc91ccba60">XDfeOfdm_CarrierCfg::FftSize</a>, <a class="el" href="struct_x_dfe_ofdm___internal_carrier_cfg.html#a1b001fa194a4d3fe13c200a4f491324e">XDfeOfdm_InternalCarrierCfg::FftSize</a>, <a class="el" href="struct_x_dfe_ofdm___c_c_sequence.html#ad10a1708e5beb766fa2407c3758b1a42">XDfeOfdm_CCSequence::Length</a>, <a class="el" href="struct_x_dfe_ofdm___carrier_cfg.html#a9c5b2618474f9abfff97ce4d6cb8e04a">XDfeOfdm_CarrierCfg::Numerology</a>, <a class="el" href="struct_x_dfe_ofdm___internal_carrier_cfg.html#af5a13d6f57aadd11848a84273fd57046">XDfeOfdm_InternalCarrierCfg::Numerology</a>, <a class="el" href="struct_x_dfe_ofdm___carrier_cfg.html#a8e89be7280a23bf544fe02ea64627477">XDfeOfdm_CarrierCfg::NumSubcarriers</a>, <a class="el" href="struct_x_dfe_ofdm___internal_carrier_cfg.html#a6c1777dfb0d4cc4573474a717cc58c98">XDfeOfdm_InternalCarrierCfg::NumSubcarriers</a>, <a class="el" href="struct_x_dfe_ofdm___carrier_cfg.html#a5df249fedf2fba3dd80b9f25815a69db">XDfeOfdm_CarrierCfg::OutputDelay</a>, <a class="el" href="struct_x_dfe_ofdm___internal_carrier_cfg.html#a8457668b7f4ead556ab56c5cc3bd64eb">XDfeOfdm_InternalCarrierCfg::OutputDelay</a>, <a class="el" href="struct_x_dfe_ofdm___carrier_cfg.html#a5e7eccd516549e6547c4881c74bf578c">XDfeOfdm_CarrierCfg::ScaleFactor</a>, and <a class="el" href="struct_x_dfe_ofdm___internal_carrier_cfg.html#ad9ec683d3980800f0a067b0e329f749c">XDfeOfdm_InternalCarrierCfg::ScaleFactor</a>.</p>

</div>
</div>
<a class="anchor" id="ga895d37558bb4351d118f1970d79a2d7b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XDfeOfdm_GetCurrentCCCfg </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_dfe_ofdm___c_c_cfg.html">XDfeOfdm_CCCfg</a> *&#160;</td>
          <td class="paramname"><em>CurrCCCfg</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the current CC configuration. </p>
<p>Not used slot ID in a sequence (Sequence.CCID[Index]) are represented as (-1), not the value in registers.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the OFDM instance. </td></tr>
    <tr><td class="paramname">CurrCCCfg</td><td>CC configuration container.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>For a sequence conversion see <a class="el" href="group__dfeofdm.html#gade552f0bcf5ed9eac51ca4fcc4b983fa" title="Adds specified CCID, with specified configuration, to a local CC configuration structure. ">XDfeOfdm_AddCCtoCCCfg()</a> comment. </dd></dl>

<p>References <a class="el" href="struct_x_dfe_ofdm___c_c_cfg.html#af8215954862eaa1ceb1cdf785003abb5">XDfeOfdm_CCCfg::CarrierCfg</a>, <a class="el" href="struct_x_dfe_ofdm___c_c_sequence.html#aaab78fa8bb86d61092ca378481dabe8b">XDfeOfdm_CCSequence::CCID</a>, <a class="el" href="struct_x_dfe_ofdm___f_t_sequence.html#abb1dfc3322c160a614c6ef1d368767f5">XDfeOfdm_FTSequence::CCID</a>, <a class="el" href="struct_x_dfe_ofdm___c_c_cfg.html#a76a6f2071855ae642f660f362342666e">XDfeOfdm_CCCfg::CCSequence</a>, <a class="el" href="struct_x_dfe_ofdm.html#aa1738ac34100b358af36b726814d1d09">XDfeOfdm::CCSequenceLength</a>, <a class="el" href="struct_x_dfe_ofdm___c_c_cfg.html#a76ec325f1e745eab6ac9ffeb8f5b8513">XDfeOfdm_CCCfg::FTSequence</a>, <a class="el" href="struct_x_dfe_ofdm___c_c_sequence.html#ad10a1708e5beb766fa2407c3758b1a42">XDfeOfdm_CCSequence::Length</a>, <a class="el" href="struct_x_dfe_ofdm___f_t_sequence.html#a1c5d8cfef8f5dbaff69b2a110bc6b9f9">XDfeOfdm_FTSequence::Length</a>, <a class="el" href="struct_x_dfe_ofdm.html#a7d4890cb9afbd7f99f1834e5742ac006">XDfeOfdm::NotUsedCCID</a>, and <a class="el" href="group__dfeofdm.html#gab8b2ac9b5c081fc45107e1e5f682b157">XDFEOFDM_CC_NUM</a>.</p>

<p>Referenced by <a class="el" href="group__dfeofdm.html#gaf304555910bc042c2de8437ac0b448d3">XDfeOfdm_MultiAddCCExample()</a>.</p>

</div>
</div>
<a class="anchor" id="ga7b9560e67cf92d7147e83f67d72f9f6f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XDfeOfdm_GetDataLatency </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns data latency. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the OFDM instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returned data latency. </dd></dl>

</div>
</div>
<a class="anchor" id="ga0f253b33e1be8d4b37bbddf681669a13"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XDfeOfdm_GetEmptyCCCfg </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_dfe_ofdm___c_c_cfg.html">XDfeOfdm_CCCfg</a> *&#160;</td>
          <td class="paramname"><em>CCCfg</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns configuration structure CCCfg with CCCfg-&gt;CCSequence.Length value set in <a class="el" href="group__dfeofdm.html#ga8248b6bc1f2f9dd0f5b2a04c62062753" title="Reads configuration from device tree/xparameters.h and IP registers. ">XDfeOfdm_Configure()</a>, array CCCfg-&gt;CCSequence.CCID[] members are set to not used value (-1) and the other CCCfg members are set to 0. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the OFDM instance. </td></tr>
    <tr><td class="paramname">CCCfg</td><td>CC configuration container. </td></tr>
  </table>
  </dd>
</dl>

<p>References <a class="el" href="struct_x_dfe_ofdm___c_c_sequence.html#aaab78fa8bb86d61092ca378481dabe8b">XDfeOfdm_CCSequence::CCID</a>, <a class="el" href="struct_x_dfe_ofdm___f_t_sequence.html#abb1dfc3322c160a614c6ef1d368767f5">XDfeOfdm_FTSequence::CCID</a>, <a class="el" href="struct_x_dfe_ofdm___c_c_cfg.html#a76a6f2071855ae642f660f362342666e">XDfeOfdm_CCCfg::CCSequence</a>, <a class="el" href="struct_x_dfe_ofdm.html#aa1738ac34100b358af36b726814d1d09">XDfeOfdm::CCSequenceLength</a>, <a class="el" href="struct_x_dfe_ofdm___c_c_cfg.html#a76ec325f1e745eab6ac9ffeb8f5b8513">XDfeOfdm_CCCfg::FTSequence</a>, <a class="el" href="struct_x_dfe_ofdm___c_c_sequence.html#ad10a1708e5beb766fa2407c3758b1a42">XDfeOfdm_CCSequence::Length</a>, <a class="el" href="struct_x_dfe_ofdm___f_t_sequence.html#a1c5d8cfef8f5dbaff69b2a110bc6b9f9">XDfeOfdm_FTSequence::Length</a>, and <a class="el" href="group__dfeofdm.html#gab8b2ac9b5c081fc45107e1e5f682b157">XDFEOFDM_CC_NUM</a>.</p>

</div>
</div>
<a class="anchor" id="ga19ffdc5cb149de0d08af7b2489fb5a0e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XDfeOfdm_GetEventStatus </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_dfe_ofdm___status.html">XDfeOfdm_Status</a> *&#160;</td>
          <td class="paramname"><em>Status</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets event status. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the OFDM instance. </td></tr>
    <tr><td class="paramname">Status</td><td>Pointer to a returned event status. </td></tr>
  </table>
  </dd>
</dl>

<p>References <a class="el" href="struct_x_dfe_ofdm___status.html#acf8828edf030249444e48a6ddba48600">XDfeOfdm_Status::CCUpdate</a>, <a class="el" href="struct_x_dfe_ofdm___status.html#a44d833d3eb4c76c14f844e3e3b3b8b4a">XDfeOfdm_Status::FTCCSequenceError</a>, <a class="el" href="struct_x_dfe_ofdm___status.html#aa2c11c23eceeae6341234d06c19edce8">XDfeOfdm_Status::Overflow</a>, <a class="el" href="struct_x_dfe_ofdm___status.html#aace4b8584b3e30af0f4665953329bb93">XDfeOfdm_Status::Saturation</a>, <a class="el" href="struct_x_dfe_ofdm___status.html#adf029f9a8749eeb0e32c7b746862cc6d">XDfeOfdm_Status::SaturationCCID</a>, and <a class="el" href="struct_x_dfe_ofdm___status.html#aa08cdef43e5dee673925674a92cd8512">XDfeOfdm_Status::SaturationCount</a>.</p>

</div>
</div>
<a class="anchor" id="gaa653cb59c46752bf69a87541679ce65f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XDfeOfdm_GetInterruptMask </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_dfe_ofdm___interrupt_mask.html">XDfeOfdm_InterruptMask</a> *&#160;</td>
          <td class="paramname"><em>Mask</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets interrupt masks. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the OFDM instance. </td></tr>
    <tr><td class="paramname">Mask</td><td>Interrupt mask value. </td></tr>
  </table>
  </dd>
</dl>

<p>References <a class="el" href="struct_x_dfe_ofdm___interrupt_mask.html#a5c15043f94d8d6fc50f2adace2b5cf6e">XDfeOfdm_InterruptMask::CCUpdate</a>, <a class="el" href="struct_x_dfe_ofdm___interrupt_mask.html#a8a4b6b0b25807e006b10f796f370f0d4">XDfeOfdm_InterruptMask::FTCCSequenceError</a>, <a class="el" href="struct_x_dfe_ofdm___interrupt_mask.html#a97ced32c8a8cd23f9ed64f321b9ee337">XDfeOfdm_InterruptMask::Overflow</a>, and <a class="el" href="struct_x_dfe_ofdm___interrupt_mask.html#a3b2fae4f642b7c02b2a3605a69ff3e7d">XDfeOfdm_InterruptMask::Saturation</a>.</p>

</div>
</div>
<a class="anchor" id="ga090de51506092c4ad878aea98e85bec2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__dfeofdm.html#ga8fe9073be4e4298b7c4bf8fe8c565b2a">XDfeOfdm_StateId</a> XDfeOfdm_GetStateID </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets a state machine state ID. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the OFDM instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>State machine StateID </dd></dl>

<p>References <a class="el" href="struct_x_dfe_ofdm.html#a1e567a49d18d5f25268062a28bb0e7a4">XDfeOfdm::StateId</a>.</p>

</div>
</div>
<a class="anchor" id="ga8432ece95eb4a12d2f1eb60e87436809"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XDfeOfdm_GetTriggersCfg </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_dfe_ofdm___trigger_cfg.html">XDfeOfdm_TriggerCfg</a> *&#160;</td>
          <td class="paramname"><em>TriggerCfg</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the current trigger configuration. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the OFDM instance. </td></tr>
    <tr><td class="paramname">TriggerCfg</td><td>Trigger configuration container. </td></tr>
  </table>
  </dd>
</dl>

<p>References <a class="el" href="struct_x_dfe_ofdm___trigger_cfg.html#aa57868c1544ac36a8c3c0df957280b3f">XDfeOfdm_TriggerCfg::Activate</a>, <a class="el" href="struct_x_dfe_ofdm___trigger_cfg.html#aa18f8fff86f7d41df716d87e6332665f">XDfeOfdm_TriggerCfg::CCUpdate</a>, <a class="el" href="struct_x_dfe_ofdm___trigger_cfg.html#af491898987784d03f07c2a9074ec11f2">XDfeOfdm_TriggerCfg::LowPower</a>, <a class="el" href="struct_x_dfe_ofdm___trigger.html#a7588c100fa85f1c3921c785dc949577b">XDfeOfdm_Trigger::Mode</a>, <a class="el" href="struct_x_dfe_ofdm.html#a1e567a49d18d5f25268062a28bb0e7a4">XDfeOfdm::StateId</a>, <a class="el" href="struct_x_dfe_ofdm___trigger.html#a1fa09d1d1e1eb52f107b13c4aee499e0">XDfeOfdm_Trigger::StateOutput</a>, <a class="el" href="struct_x_dfe_ofdm___trigger.html#a37c8475c743bbb66242ae0abdeba3be6">XDfeOfdm_Trigger::TriggerEnable</a>, <a class="el" href="struct_x_dfe_ofdm___trigger.html#a08962b0f9f87949435bb7d06891bc00f">XDfeOfdm_Trigger::TUSERBit</a>, <a class="el" href="struct_x_dfe_ofdm___trigger.html#afa7f0e1385ceb726bc0675cdbe6afc8f">XDfeOfdm_Trigger::TuserEdgeLevel</a>, and <a class="el" href="group__dfeofdm.html#gga8fe9073be4e4298b7c4bf8fe8c565b2aa18fda0537eb680a4d71a6565095c1b1a">XDFEOFDM_STATE_NOT_READY</a>.</p>

</div>
</div>
<a class="anchor" id="ga30994109ba67bcfc2e73f644e422d056"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XDfeOfdm_GetTuserCCUpdateTrigger </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets the TUSER CC Update trigger. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the OFDM instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>TUSER CC Update trigger </dd></dl>

</div>
</div>
<a class="anchor" id="ga3f5f28e00b7b56e9ea37d4336543f998"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XDfeOfdm_GetTUserDelay </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reads the delay, which will be added to TUSER and TLAST (delay matched through the IP). </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the OFDM instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Delay value </dd></dl>

</div>
</div>
<a class="anchor" id="ga54bde32062a405022c4d2881439f61a2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XDfeOfdm_GetTuserOutFrameLocation </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets the TUSER Framing bit location register where bit location indicates which bit to be used for sending framing information on DL_DOUT IF and M_AXIS_TBASE IF. </p>
<p>TUSER bit width is fixed to its default value of 8. Therefore, legal values of FRAME_BIT are 0 to 7.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the OFDM instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>TUSER OutFrame Location </dd></dl>

</div>
</div>
<a class="anchor" id="ga95bec20efb52b90b2b6a2d96e51e8989"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XDfeOfdm_GetVersions </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_dfe_ofdm___version.html">XDfeOfdm_Version</a> *&#160;</td>
          <td class="paramname"><em>SwVersion</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_dfe_ofdm___version.html">XDfeOfdm_Version</a> *&#160;</td>
          <td class="paramname"><em>HwVersion</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets the driver version. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">SwVersion</td><td>Driver version numbers. </td></tr>
    <tr><td class="paramname">HwVersion</td><td>HW version numbers. </td></tr>
  </table>
  </dd>
</dl>

<p>References <a class="el" href="struct_x_dfe_ofdm___version.html#a9aa2f3a5d250912399f20e9e781c085b">XDfeOfdm_Version::Major</a>, <a class="el" href="struct_x_dfe_ofdm___version.html#af5fcebc75c34601d4a802e10cce5409c">XDfeOfdm_Version::Minor</a>, <a class="el" href="struct_x_dfe_ofdm___version.html#a07307e027316a832b6234574fc99383f">XDfeOfdm_Version::Patch</a>, <a class="el" href="struct_x_dfe_ofdm___version.html#a253dc76cd0f291a746d1daac0ae53486">XDfeOfdm_Version::Revision</a>, <a class="el" href="struct_x_dfe_ofdm.html#a1e567a49d18d5f25268062a28bb0e7a4">XDfeOfdm::StateId</a>, <a class="el" href="group__dfeofdm.html#gaca6bdd93682f011cf7af49604858e6c4">XDFEOFDM_DRIVER_VERSION_MAJOR</a>, <a class="el" href="group__dfeofdm.html#gab4ee35983c0d92285d640affefc3dcad">XDFEOFDM_DRIVER_VERSION_MINOR</a>, and <a class="el" href="group__dfeofdm.html#gga8fe9073be4e4298b7c4bf8fe8c565b2aa18fda0537eb680a4d71a6565095c1b1a">XDFEOFDM_STATE_NOT_READY</a>.</p>

<p>Referenced by <a class="el" href="group__dfeofdm.html#ga6d938668e6e1b73a585775cbe0eab471">XDfeOfdm_AddCCExample()</a>, and <a class="el" href="group__dfeofdm.html#gaf304555910bc042c2de8437ac0b448d3">XDfeOfdm_MultiAddCCExample()</a>.</p>

</div>
</div>
<a class="anchor" id="ga01a406ff1a9f5562ee5fc7c7a28ea237"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XDfeOfdm_Initialize </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_dfe_ofdm___init.html">XDfeOfdm_Init</a> *&#160;</td>
          <td class="paramname"><em>Init</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initializes the OFDM driver and moves the state machine to an initialized state. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the OFDM instance. </td></tr>
    <tr><td class="paramname">Init</td><td>Initialization data container. </td></tr>
  </table>
  </dd>
</dl>

<p>References <a class="el" href="struct_x_dfe_ofdm___init.html#a442ea1755b41de1b2b2b8dec54c638f3">XDfeOfdm_Init::CCSequenceLength</a>, <a class="el" href="struct_x_dfe_ofdm.html#aa1738ac34100b358af36b726814d1d09">XDfeOfdm::CCSequenceLength</a>, <a class="el" href="struct_x_dfe_ofdm.html#a7d4890cb9afbd7f99f1834e5742ac006">XDfeOfdm::NotUsedCCID</a>, <a class="el" href="struct_x_dfe_ofdm.html#a1e567a49d18d5f25268062a28bb0e7a4">XDfeOfdm::StateId</a>, <a class="el" href="group__dfeofdm.html#gga8fe9073be4e4298b7c4bf8fe8c565b2aa80209d129faeae7e529b68c3927db3cf">XDFEOFDM_STATE_CONFIGURED</a>, and <a class="el" href="group__dfeofdm.html#gga8fe9073be4e4298b7c4bf8fe8c565b2aa697df6f5fef047d5a215f24b86203c04">XDFEOFDM_STATE_INITIALISED</a>.</p>

<p>Referenced by <a class="el" href="group__dfeofdm.html#ga6d938668e6e1b73a585775cbe0eab471">XDfeOfdm_AddCCExample()</a>, and <a class="el" href="group__dfeofdm.html#gaf304555910bc042c2de8437ac0b448d3">XDfeOfdm_MultiAddCCExample()</a>.</p>

</div>
</div>
<a class="anchor" id="ga765082b84acafa5bcef9c2ad92bb7cf6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XDfeOfdm_InstanceClose </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Closes the instances of the OFDM driver and moves the state machine to a Not Ready state. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the OFDM instance. </td></tr>
  </table>
  </dd>
</dl>

<p>References <a class="el" href="struct_x_dfe_ofdm.html#a8aa2214cf5d791e9a2992027ede72936">XDfeOfdm::Device</a>, <a class="el" href="struct_x_dfe_ofdm.html#a13700eb62a7a5d65decb22b291f09edb">XDfeOfdm::NodeName</a>, <a class="el" href="struct_x_dfe_ofdm.html#a1e567a49d18d5f25268062a28bb0e7a4">XDfeOfdm::StateId</a>, <a class="el" href="group__dfeofdm.html#gac89bab3faf02d647cf50864711fcde4e">XDFEOFDM_INSTANCE_EXISTS</a>, and <a class="el" href="group__dfeofdm.html#gga8fe9073be4e4298b7c4bf8fe8c565b2aa18fda0537eb680a4d71a6565095c1b1a">XDFEOFDM_STATE_NOT_READY</a>.</p>

<p>Referenced by <a class="el" href="group__dfeofdm.html#ga6d938668e6e1b73a585775cbe0eab471">XDfeOfdm_AddCCExample()</a>, and <a class="el" href="group__dfeofdm.html#gaf304555910bc042c2de8437ac0b448d3">XDfeOfdm_MultiAddCCExample()</a>.</p>

</div>
</div>
<a class="anchor" id="ga432a6579323bb9a5ec591489ffc2ac0f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> * XDfeOfdm_InstanceInit </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>DeviceNodeName</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initializes one instance of the OFDM driver and traverses the "/sys/bus/platform/device" directory (in Linux) to find the registered OFDM device with the name DeviceNodeName. </p>
<p>The first available slot in the instances array XDfeOfdm_Ofdm[] will be taken as a DeviceNodeName object. On success, it moves the state machine to a Ready state, while on failure, it stays in a Not Ready state.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">DeviceNodeName</td><td>Device node name.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>Pointer to the instance if successful.</li>
<li>NULL on error. </li>
</ul>
</dd></dl>

<p>References <a class="el" href="struct_x_dfe_ofdm.html#a8aa2214cf5d791e9a2992027ede72936">XDfeOfdm::Device</a>, <a class="el" href="struct_x_dfe_ofdm.html#a13700eb62a7a5d65decb22b291f09edb">XDfeOfdm::NodeName</a>, <a class="el" href="struct_x_dfe_ofdm.html#a1e567a49d18d5f25268062a28bb0e7a4">XDfeOfdm::StateId</a>, <a class="el" href="group__dfeofdm.html#gac89bab3faf02d647cf50864711fcde4e">XDFEOFDM_INSTANCE_EXISTS</a>, <a class="el" href="group__dfeofdm.html#ga2b1ba159bec0d962b41efafc034d2eae">XDFEOFDM_NODE_NAME_MAX_LENGTH</a>, <a class="el" href="group__dfeofdm.html#gga8fe9073be4e4298b7c4bf8fe8c565b2aa18fda0537eb680a4d71a6565095c1b1a">XDFEOFDM_STATE_NOT_READY</a>, <a class="el" href="group__dfeofdm.html#gga8fe9073be4e4298b7c4bf8fe8c565b2aa56db899ae9d39e13af58ecb472ef9448">XDFEOFDM_STATE_READY</a>, <a class="el" href="group__dfeofdm.html#ga9478d2b97aa40e09052dee2571940ef9">XST_FAILURE</a>, and <a class="el" href="group__dfeofdm.html#ga959ffc15251ddc9b3a883a30f97b7715">XST_SUCCESS</a>.</p>

<p>Referenced by <a class="el" href="group__dfeofdm.html#ga6d938668e6e1b73a585775cbe0eab471">XDfeOfdm_AddCCExample()</a>, and <a class="el" href="group__dfeofdm.html#gaf304555910bc042c2de8437ac0b448d3">XDfeOfdm_MultiAddCCExample()</a>.</p>

</div>
</div>
<a class="anchor" id="gaf304555910bc042c2de8437ac0b448d3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XDfeOfdm_MultiAddCCExample </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function runs the DFE OFDM device using the driver APIs. </p>
<p>This function does the following tasks:</p>
<ul>
<li>Create and system initialize the device driver instance.</li>
<li>Read SW and HW version numbers.</li>
<li>Reset the device.</li>
<li>Configure the device.</li>
<li>Initialize the device.</li>
<li>Set the triggers</li>
<li>Activate the device.</li>
<li>Add CC.</li>
<li>Deactivate the device.</li>
</ul>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if the example has completed successfully.</li>
<li>XST_FAILURE if the example has failed.//! [testexample2] </li>
</ul>
</dd></dl>

<p>References <a class="el" href="struct_x_dfe_ofdm___trigger_cfg.html#aa57868c1544ac36a8c3c0df957280b3f">XDfeOfdm_TriggerCfg::Activate</a>, <a class="el" href="struct_x_dfe_ofdm___model_parameters.html#ab3eea5fdd0f6aef6e40b19c2a4e9f87a">XDfeOfdm_ModelParameters::AntennaInterleave</a>, <a class="el" href="struct_x_dfe_ofdm___config.html#a7019e60230034c910288a2a3e2523884">XDfeOfdm_Config::AntennaInterleave</a>, <a class="el" href="struct_x_dfe_ofdm___config.html#a000fe7aff8b1a94854d52906b74516e9">XDfeOfdm_Config::BaseAddr</a>, <a class="el" href="struct_x_dfe_ofdm___init.html#a442ea1755b41de1b2b2b8dec54c638f3">XDfeOfdm_Init::CCSequenceLength</a>, <a class="el" href="struct_x_dfe_ofdm___trigger_cfg.html#aa18f8fff86f7d41df716d87e6332665f">XDfeOfdm_TriggerCfg::CCUpdate</a>, <a class="el" href="struct_x_dfe_ofdm___status.html#acf8828edf030249444e48a6ddba48600">XDfeOfdm_Status::CCUpdate</a>, <a class="el" href="struct_x_dfe_ofdm___carrier_cfg.html#a686973c0ebb9efea76c75f12c751c797">XDfeOfdm_CarrierCfg::CommsStandard</a>, <a class="el" href="struct_x_dfe_ofdm.html#a8400ce059751b5bc46dbce6cf9cc8e3f">XDfeOfdm::Config</a>, <a class="el" href="struct_x_dfe_ofdm___carrier_cfg.html#a28c3b141657d28642106a2dc91ccba60">XDfeOfdm_CarrierCfg::FftSize</a>, <a class="el" href="struct_x_dfe_ofdm___status.html#a44d833d3eb4c76c14f844e3e3b3b8b4a">XDfeOfdm_Status::FTCCSequenceError</a>, <a class="el" href="struct_x_dfe_ofdm___f_t_sequence.html#a1c5d8cfef8f5dbaff69b2a110bc6b9f9">XDfeOfdm_FTSequence::Length</a>, <a class="el" href="struct_x_dfe_ofdm___version.html#a9aa2f3a5d250912399f20e9e781c085b">XDfeOfdm_Version::Major</a>, <a class="el" href="struct_x_dfe_ofdm___version.html#af5fcebc75c34601d4a802e10cce5409c">XDfeOfdm_Version::Minor</a>, <a class="el" href="struct_x_dfe_ofdm___trigger.html#a7588c100fa85f1c3921c785dc949577b">XDfeOfdm_Trigger::Mode</a>, <a class="el" href="struct_x_dfe_ofdm___cfg.html#a38c1c79086484df53f2f1a6285f2d9f8">XDfeOfdm_Cfg::ModelParams</a>, <a class="el" href="struct_x_dfe_ofdm.html#a13700eb62a7a5d65decb22b291f09edb">XDfeOfdm::NodeName</a>, <a class="el" href="struct_x_dfe_ofdm___model_parameters.html#adc43d413c0fb6208c2e5562f4b33f157">XDfeOfdm_ModelParameters::NumAntenna</a>, <a class="el" href="struct_x_dfe_ofdm___config.html#aaa5d6fa86588a75218cd3cd5562c2353">XDfeOfdm_Config::NumAntenna</a>, <a class="el" href="struct_x_dfe_ofdm___carrier_cfg.html#a9c5b2618474f9abfff97ce4d6cb8e04a">XDfeOfdm_CarrierCfg::Numerology</a>, <a class="el" href="struct_x_dfe_ofdm___carrier_cfg.html#a8e89be7280a23bf544fe02ea64627477">XDfeOfdm_CarrierCfg::NumSubcarriers</a>, <a class="el" href="struct_x_dfe_ofdm___carrier_cfg.html#a5df249fedf2fba3dd80b9f25815a69db">XDfeOfdm_CarrierCfg::OutputDelay</a>, <a class="el" href="struct_x_dfe_ofdm___version.html#a07307e027316a832b6234574fc99383f">XDfeOfdm_Version::Patch</a>, <a class="el" href="struct_x_dfe_ofdm___version.html#a253dc76cd0f291a746d1daac0ae53486">XDfeOfdm_Version::Revision</a>, <a class="el" href="struct_x_dfe_ofdm___status.html#aace4b8584b3e30af0f4665953329bb93">XDfeOfdm_Status::Saturation</a>, <a class="el" href="struct_x_dfe_ofdm___status.html#adf029f9a8749eeb0e32c7b746862cc6d">XDfeOfdm_Status::SaturationCCID</a>, <a class="el" href="struct_x_dfe_ofdm___status.html#aa08cdef43e5dee673925674a92cd8512">XDfeOfdm_Status::SaturationCount</a>, <a class="el" href="struct_x_dfe_ofdm___carrier_cfg.html#a5e7eccd516549e6547c4881c74bf578c">XDfeOfdm_CarrierCfg::ScaleFactor</a>, <a class="el" href="struct_x_dfe_ofdm___trigger.html#a08962b0f9f87949435bb7d06891bc00f">XDfeOfdm_Trigger::TUSERBit</a>, <a class="el" href="struct_x_dfe_ofdm___trigger.html#afa7f0e1385ceb726bc0675cdbe6afc8f">XDfeOfdm_Trigger::TuserEdgeLevel</a>, <a class="el" href="struct_x_dfe_ofdm___cfg.html#ad9d93d7772122b3375effab5910358a5">XDfeOfdm_Cfg::Version</a>, <a class="el" href="group__dfeofdm.html#ga17cc3a5b3f29a0dc0065018d0fe3ec98">XDfeOfdm_Activate()</a>, <a class="el" href="group__dfeofdm.html#gade552f0bcf5ed9eac51ca4fcc4b983fa">XDfeOfdm_AddCCtoCCCfg()</a>, <a class="el" href="group__dfeofdm.html#gaba6f602fc482a8c8fd22320d2ba34356">XDfeOfdm_ClearEventStatus()</a>, <a class="el" href="group__dfeofdm.html#ga8248b6bc1f2f9dd0f5b2a04c62062753">XDfeOfdm_Configure()</a>, <a class="el" href="group__dfeofdm.html#ga8c3460b747d8e053c0bcb66a36b1a827">XDfeOfdm_Deactivate()</a>, <a class="el" href="group__dfeofdm.html#ga895d37558bb4351d118f1970d79a2d7b">XDfeOfdm_GetCurrentCCCfg()</a>, <a class="el" href="group__dfeofdm.html#ga95bec20efb52b90b2b6a2d96e51e8989">XDfeOfdm_GetVersions()</a>, <a class="el" href="group__dfeofdm.html#ga01a406ff1a9f5562ee5fc7c7a28ea237">XDfeOfdm_Initialize()</a>, <a class="el" href="group__dfeofdm.html#ga765082b84acafa5bcef9c2ad92bb7cf6">XDfeOfdm_InstanceClose()</a>, <a class="el" href="group__dfeofdm.html#ga432a6579323bb9a5ec591489ffc2ac0f">XDfeOfdm_InstanceInit()</a>, <a class="el" href="group__dfeofdm.html#ga337fe11e6ef1bef0727ba3b9ee59b10f">XDfeOfdm_Reset()</a>, <a class="el" href="group__dfeofdm.html#ga9daeab383fd324e6812ae53d248ceeaa">XDfeOfdm_SetNextCCCfgAndTrigger()</a>, <a class="el" href="group__dfeofdm.html#ga5e4d810d0e04bbad650fbb60115254e4">XDfeOfdm_SetTriggersCfg()</a>, <a class="el" href="group__dfeofdm.html#ga9478d2b97aa40e09052dee2571940ef9">XST_FAILURE</a>, and <a class="el" href="group__dfeofdm.html#ga959ffc15251ddc9b3a883a30f97b7715">XST_SUCCESS</a>.</p>

<p>Referenced by <a class="el" href="xdfeofdm__examples_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main()</a>.</p>

</div>
</div>
<a class="anchor" id="ga030e66a15c8f0c1b4493aa605dca2c30"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XDfeOfdm_RemoveCCfromCCCfg </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_dfe_ofdm___c_c_cfg.html">XDfeOfdm_CCCfg</a> *&#160;</td>
          <td class="paramname"><em>CCCfg</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">s32&#160;</td>
          <td class="paramname"><em>CCID</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_dfe_ofdm___f_t_sequence.html">XDfeOfdm_FTSequence</a> *&#160;</td>
          <td class="paramname"><em>FTSeq</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Removes specified CCID from a local CC configuration structure. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the OFDM instance. </td></tr>
    <tr><td class="paramname">CCCfg</td><td>Component carrier (CC) configuration container. </td></tr>
    <tr><td class="paramname">CCID</td><td>CC ID.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if successful.</li>
<li>XST_FAILURE if error occurs.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>For a sequence conversion see XDfeOfdm_AddCCtoCCCfg comment. </dd></dl>

<p>References <a class="el" href="struct_x_dfe_ofdm___c_c_cfg.html#af8215954862eaa1ceb1cdf785003abb5">XDfeOfdm_CCCfg::CarrierCfg</a>, <a class="el" href="struct_x_dfe_ofdm___c_c_cfg.html#a76a6f2071855ae642f660f362342666e">XDfeOfdm_CCCfg::CCSequence</a>, <a class="el" href="struct_x_dfe_ofdm___internal_carrier_cfg.html#ad7d569669e17596881cc055545c38334">XDfeOfdm_InternalCarrierCfg::Enable</a>, <a class="el" href="struct_x_dfe_ofdm___f_t_sequence.html#a1c5d8cfef8f5dbaff69b2a110bc6b9f9">XDfeOfdm_FTSequence::Length</a>, <a class="el" href="group__dfeofdm.html#ga9478d2b97aa40e09052dee2571940ef9">XST_FAILURE</a>, and <a class="el" href="group__dfeofdm.html#ga959ffc15251ddc9b3a883a30f97b7715">XST_SUCCESS</a>.</p>

</div>
</div>
<a class="anchor" id="ga337fe11e6ef1bef0727ba3b9ee59b10f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XDfeOfdm_Reset </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Resets the OFDM instance and puts block into a reset state. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the OFDM instance. </td></tr>
  </table>
  </dd>
</dl>

<p>References <a class="el" href="struct_x_dfe_ofdm.html#a1e567a49d18d5f25268062a28bb0e7a4">XDfeOfdm::StateId</a>, <a class="el" href="group__dfeofdm.html#gga8fe9073be4e4298b7c4bf8fe8c565b2aa18fda0537eb680a4d71a6565095c1b1a">XDFEOFDM_STATE_NOT_READY</a>, and <a class="el" href="group__dfeofdm.html#gga8fe9073be4e4298b7c4bf8fe8c565b2aa4bb607567495464ddbb620d55a620509">XDFEOFDM_STATE_RESET</a>.</p>

<p>Referenced by <a class="el" href="group__dfeofdm.html#ga6d938668e6e1b73a585775cbe0eab471">XDfeOfdm_AddCCExample()</a>, and <a class="el" href="group__dfeofdm.html#gaf304555910bc042c2de8437ac0b448d3">XDfeOfdm_MultiAddCCExample()</a>.</p>

</div>
</div>
<a class="anchor" id="ga500a580c416fd8a48cdce2b0844f7206"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XDfeOfdm_SetInterruptMask </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="struct_x_dfe_ofdm___interrupt_mask.html">XDfeOfdm_InterruptMask</a> *&#160;</td>
          <td class="paramname"><em>Mask</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets interrupt masks. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the OFDM instance. </td></tr>
    <tr><td class="paramname">Mask</td><td>Interrupt mask value.<ul>
<li>0 - Does not mask the corresponding interrupt</li>
<li>1 - Masks the corresponding interrupt </li>
</ul>
</td></tr>
  </table>
  </dd>
</dl>

<p>References <a class="el" href="struct_x_dfe_ofdm___interrupt_mask.html#a5c15043f94d8d6fc50f2adace2b5cf6e">XDfeOfdm_InterruptMask::CCUpdate</a>, <a class="el" href="struct_x_dfe_ofdm___interrupt_mask.html#a8a4b6b0b25807e006b10f796f370f0d4">XDfeOfdm_InterruptMask::FTCCSequenceError</a>, <a class="el" href="struct_x_dfe_ofdm___interrupt_mask.html#a97ced32c8a8cd23f9ed64f321b9ee337">XDfeOfdm_InterruptMask::Overflow</a>, and <a class="el" href="struct_x_dfe_ofdm___interrupt_mask.html#a3b2fae4f642b7c02b2a3605a69ff3e7d">XDfeOfdm_InterruptMask::Saturation</a>.</p>

</div>
</div>
<a class="anchor" id="gaef40749e07cdc3a4a00a2e8228d5d8b8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XDfeOfdm_SetNextCCCfg </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="struct_x_dfe_ofdm___c_c_cfg.html">XDfeOfdm_CCCfg</a> *&#160;</td>
          <td class="paramname"><em>NextCCCfg</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets the next CC configuration. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the OFDM instance. </td></tr>
    <tr><td class="paramname">NextCCCfg</td><td>Next CC configuration container. </td></tr>
  </table>
  </dd>
</dl>

<p>References <a class="el" href="struct_x_dfe_ofdm___c_c_cfg.html#af8215954862eaa1ceb1cdf785003abb5">XDfeOfdm_CCCfg::CarrierCfg</a>, <a class="el" href="struct_x_dfe_ofdm___c_c_sequence.html#aaab78fa8bb86d61092ca378481dabe8b">XDfeOfdm_CCSequence::CCID</a>, <a class="el" href="struct_x_dfe_ofdm___f_t_sequence.html#abb1dfc3322c160a614c6ef1d368767f5">XDfeOfdm_FTSequence::CCID</a>, <a class="el" href="struct_x_dfe_ofdm___c_c_cfg.html#a76a6f2071855ae642f660f362342666e">XDfeOfdm_CCCfg::CCSequence</a>, <a class="el" href="struct_x_dfe_ofdm.html#aa1738ac34100b358af36b726814d1d09">XDfeOfdm::CCSequenceLength</a>, <a class="el" href="struct_x_dfe_ofdm___internal_carrier_cfg.html#a2be0adf2857f6b06b6b016fea30a8d34">XDfeOfdm_InternalCarrierCfg::CommsStandard</a>, <a class="el" href="struct_x_dfe_ofdm___internal_carrier_cfg.html#ad7d569669e17596881cc055545c38334">XDfeOfdm_InternalCarrierCfg::Enable</a>, <a class="el" href="struct_x_dfe_ofdm___internal_carrier_cfg.html#a1b001fa194a4d3fe13c200a4f491324e">XDfeOfdm_InternalCarrierCfg::FftSize</a>, <a class="el" href="struct_x_dfe_ofdm___c_c_cfg.html#a76ec325f1e745eab6ac9ffeb8f5b8513">XDfeOfdm_CCCfg::FTSequence</a>, <a class="el" href="struct_x_dfe_ofdm___f_t_sequence.html#a1c5d8cfef8f5dbaff69b2a110bc6b9f9">XDfeOfdm_FTSequence::Length</a>, <a class="el" href="struct_x_dfe_ofdm___internal_carrier_cfg.html#af5a13d6f57aadd11848a84273fd57046">XDfeOfdm_InternalCarrierCfg::Numerology</a>, <a class="el" href="struct_x_dfe_ofdm___internal_carrier_cfg.html#a6c1777dfb0d4cc4573474a717cc58c98">XDfeOfdm_InternalCarrierCfg::NumSubcarriers</a>, <a class="el" href="struct_x_dfe_ofdm___internal_carrier_cfg.html#a8457668b7f4ead556ab56c5cc3bd64eb">XDfeOfdm_InternalCarrierCfg::OutputDelay</a>, <a class="el" href="struct_x_dfe_ofdm___internal_carrier_cfg.html#ad9ec683d3980800f0a067b0e329f749c">XDfeOfdm_InternalCarrierCfg::ScaleFactor</a>, <a class="el" href="group__dfeofdm.html#gab8b2ac9b5c081fc45107e1e5f682b157">XDFEOFDM_CC_NUM</a>, <a class="el" href="group__dfeofdm.html#gae1b70fbbb2d556355abe4fb78ee9a1ee">XDFEOFDM_CC_SEQ_LENGTH_MAX</a>, and <a class="el" href="group__dfeofdm.html#ga9f3b3e7ef1ded7f8fdb9019cc06945c7">XDFEOFDM_FT_NUM</a>.</p>

<p>Referenced by <a class="el" href="group__dfeofdm.html#ga9daeab383fd324e6812ae53d248ceeaa">XDfeOfdm_SetNextCCCfgAndTrigger()</a>.</p>

</div>
</div>
<a class="anchor" id="ga9daeab383fd324e6812ae53d248ceeaa"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XDfeOfdm_SetNextCCCfgAndTrigger </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_dfe_ofdm___c_c_cfg.html">XDfeOfdm_CCCfg</a> *&#160;</td>
          <td class="paramname"><em>CCCfg</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Writes local CC configuration to the shadow (NEXT) registers and triggers copying from shadow to operational registers. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the OFDM instance. </td></tr>
    <tr><td class="paramname">CCCfg</td><td>CC configuration container.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if successful.</li>
<li>XST_FAILURE if error occurs. </li>
</ul>
</dd></dl>

<p>References <a class="el" href="group__dfeofdm.html#gac49b03eaed4ce4083b5d51650a121158">XDfeOfdm_EnableCCUpdateTrigger()</a>, and <a class="el" href="group__dfeofdm.html#gaef40749e07cdc3a4a00a2e8228d5d8b8">XDfeOfdm_SetNextCCCfg()</a>.</p>

<p>Referenced by <a class="el" href="group__dfeofdm.html#gaf304555910bc042c2de8437ac0b448d3">XDfeOfdm_MultiAddCCExample()</a>.</p>

</div>
</div>
<a class="anchor" id="ga5e4d810d0e04bbad650fbb60115254e4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XDfeOfdm_SetTriggersCfg </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_dfe_ofdm___trigger_cfg.html">XDfeOfdm_TriggerCfg</a> *&#160;</td>
          <td class="paramname"><em>TriggerCfg</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets the trigger configuration. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the OFDM instance. </td></tr>
    <tr><td class="paramname">TriggerCfg</td><td>Trigger configuration container. </td></tr>
  </table>
  </dd>
</dl>

<p>References <a class="el" href="struct_x_dfe_ofdm___trigger_cfg.html#aa57868c1544ac36a8c3c0df957280b3f">XDfeOfdm_TriggerCfg::Activate</a>, <a class="el" href="struct_x_dfe_ofdm___trigger_cfg.html#aa18f8fff86f7d41df716d87e6332665f">XDfeOfdm_TriggerCfg::CCUpdate</a>, <a class="el" href="struct_x_dfe_ofdm___trigger_cfg.html#af491898987784d03f07c2a9074ec11f2">XDfeOfdm_TriggerCfg::LowPower</a>, <a class="el" href="struct_x_dfe_ofdm___trigger.html#a7588c100fa85f1c3921c785dc949577b">XDfeOfdm_Trigger::Mode</a>, <a class="el" href="struct_x_dfe_ofdm.html#a1e567a49d18d5f25268062a28bb0e7a4">XDfeOfdm::StateId</a>, <a class="el" href="struct_x_dfe_ofdm___trigger.html#a1fa09d1d1e1eb52f107b13c4aee499e0">XDfeOfdm_Trigger::StateOutput</a>, <a class="el" href="struct_x_dfe_ofdm___trigger.html#a37c8475c743bbb66242ae0abdeba3be6">XDfeOfdm_Trigger::TriggerEnable</a>, <a class="el" href="struct_x_dfe_ofdm___trigger.html#a08962b0f9f87949435bb7d06891bc00f">XDfeOfdm_Trigger::TUSERBit</a>, <a class="el" href="struct_x_dfe_ofdm___trigger.html#afa7f0e1385ceb726bc0675cdbe6afc8f">XDfeOfdm_Trigger::TuserEdgeLevel</a>, and <a class="el" href="group__dfeofdm.html#gga8fe9073be4e4298b7c4bf8fe8c565b2aa697df6f5fef047d5a215f24b86203c04">XDFEOFDM_STATE_INITIALISED</a>.</p>

<p>Referenced by <a class="el" href="group__dfeofdm.html#ga6d938668e6e1b73a585775cbe0eab471">XDfeOfdm_AddCCExample()</a>, and <a class="el" href="group__dfeofdm.html#gaf304555910bc042c2de8437ac0b448d3">XDfeOfdm_MultiAddCCExample()</a>.</p>

</div>
</div>
<a class="anchor" id="ga737bfbad19f05151c1eae5f7f1508893"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XDfeOfdm_SetTuserCCUpdateTrigger </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>TuserCCUpdateTrigger</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets the TUSER CC Update trigger where bit location would indicate which bit to be used for sending cc update triggering on TUSER (DL_DOUT IF and M_AXIS_TBASE IF). </p>
<p>TUSER bit width is fixed to its default value of 8. Therefore, legal values of FRAME_BIT are 0 to 7.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the OFDM instance. </td></tr>
    <tr><td class="paramname">TuserCCUpdateTrigger</td><td>Requested TUSER CC update trigger. </td></tr>
  </table>
  </dd>
</dl>

<p>References <a class="el" href="struct_x_dfe_ofdm.html#a1e567a49d18d5f25268062a28bb0e7a4">XDfeOfdm::StateId</a>, and <a class="el" href="group__dfeofdm.html#gga8fe9073be4e4298b7c4bf8fe8c565b2aab5e131c361e68b90e4351670b9b6ec85">XDFEOFDM_STATE_OPERATIONAL</a>.</p>

</div>
</div>
<a class="anchor" id="ga3233d744d373a9bd445f462a21af6118"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XDfeOfdm_SetTUserDelay </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>Delay</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets the delay to be added to TUSER and TLAST (delay matched through the IP). </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the OFDM instance. </td></tr>
    <tr><td class="paramname">Delay</td><td>Requested delay variable. </td></tr>
  </table>
  </dd>
</dl>

<p>References <a class="el" href="struct_x_dfe_ofdm.html#a1e567a49d18d5f25268062a28bb0e7a4">XDfeOfdm::StateId</a>, and <a class="el" href="group__dfeofdm.html#gga8fe9073be4e4298b7c4bf8fe8c565b2aa697df6f5fef047d5a215f24b86203c04">XDFEOFDM_STATE_INITIALISED</a>.</p>

</div>
</div>
<a class="anchor" id="gaef986bcb74ec77dff1a72b67deab3f9e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XDfeOfdm_SetTuserOutFrameLocation </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>TuserOutFrameLocation</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets the TUSER Framing bit location register where bit location indicates which bit to be used for sending the framing information on DL_DOUT IF and M_AXIS_TBASE IF. </p>
<p>TUSER bit width is fixed to its default value of 8. Therefore, legal values of FRAME_BIT are 0 to 7.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the OFDM instance. </td></tr>
    <tr><td class="paramname">TuserOutFrameLocation</td><td>Requested TUSER OutFrame location. </td></tr>
  </table>
  </dd>
</dl>

<p>References <a class="el" href="struct_x_dfe_ofdm.html#a1e567a49d18d5f25268062a28bb0e7a4">XDfeOfdm::StateId</a>, and <a class="el" href="group__dfeofdm.html#gga8fe9073be4e4298b7c4bf8fe8c565b2aab5e131c361e68b90e4351670b9b6ec85">XDFEOFDM_STATE_OPERATIONAL</a>.</p>

</div>
</div>
<a class="anchor" id="ga38d91645f0bc01f170a6333fb22f47cd"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XDfeOfdm_UpdateCCinCCCfg </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_dfe_ofdm.html">XDfeOfdm</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_dfe_ofdm___c_c_cfg.html">XDfeOfdm_CCCfg</a> *&#160;</td>
          <td class="paramname"><em>CCCfg</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">s32&#160;</td>
          <td class="paramname"><em>CCID</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="struct_x_dfe_ofdm___carrier_cfg.html">XDfeOfdm_CarrierCfg</a> *&#160;</td>
          <td class="paramname"><em>CarrierCfg</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_dfe_ofdm___f_t_sequence.html">XDfeOfdm_FTSequence</a> *&#160;</td>
          <td class="paramname"><em>FTSeq</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Updates a specified CCID with the specified configuration to a local CC configuration structure. </p>
<p>If there is insufficient capacity for the new CC the function will return an error.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>Pointer to the OFDM instance. </td></tr>
    <tr><td class="paramname">CCCfg</td><td>Component carrier (CC) configuration container. </td></tr>
    <tr><td class="paramname">CCID</td><td>CC ID. </td></tr>
    <tr><td class="paramname">CarrierCfg</td><td>CC configuration container.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if successful.</li>
<li>XST_FAILURE if error occurs. </li>
</ul>
</dd></dl>

<p>References <a class="el" href="struct_x_dfe_ofdm___c_c_cfg.html#af8215954862eaa1ceb1cdf785003abb5">XDfeOfdm_CCCfg::CarrierCfg</a>, <a class="el" href="struct_x_dfe_ofdm___carrier_cfg.html#a686973c0ebb9efea76c75f12c751c797">XDfeOfdm_CarrierCfg::CommsStandard</a>, <a class="el" href="struct_x_dfe_ofdm___internal_carrier_cfg.html#a2be0adf2857f6b06b6b016fea30a8d34">XDfeOfdm_InternalCarrierCfg::CommsStandard</a>, <a class="el" href="struct_x_dfe_ofdm___carrier_cfg.html#a28c3b141657d28642106a2dc91ccba60">XDfeOfdm_CarrierCfg::FftSize</a>, <a class="el" href="struct_x_dfe_ofdm___internal_carrier_cfg.html#a1b001fa194a4d3fe13c200a4f491324e">XDfeOfdm_InternalCarrierCfg::FftSize</a>, <a class="el" href="struct_x_dfe_ofdm___f_t_sequence.html#a1c5d8cfef8f5dbaff69b2a110bc6b9f9">XDfeOfdm_FTSequence::Length</a>, <a class="el" href="struct_x_dfe_ofdm___carrier_cfg.html#a9c5b2618474f9abfff97ce4d6cb8e04a">XDfeOfdm_CarrierCfg::Numerology</a>, <a class="el" href="struct_x_dfe_ofdm___internal_carrier_cfg.html#af5a13d6f57aadd11848a84273fd57046">XDfeOfdm_InternalCarrierCfg::Numerology</a>, <a class="el" href="struct_x_dfe_ofdm___carrier_cfg.html#a8e89be7280a23bf544fe02ea64627477">XDfeOfdm_CarrierCfg::NumSubcarriers</a>, <a class="el" href="struct_x_dfe_ofdm___internal_carrier_cfg.html#a6c1777dfb0d4cc4573474a717cc58c98">XDfeOfdm_InternalCarrierCfg::NumSubcarriers</a>, <a class="el" href="struct_x_dfe_ofdm___carrier_cfg.html#a5df249fedf2fba3dd80b9f25815a69db">XDfeOfdm_CarrierCfg::OutputDelay</a>, <a class="el" href="struct_x_dfe_ofdm___carrier_cfg.html#aa428f3c890556622538228163b94e266">XDfeOfdm_CarrierCfg::PhaseCompensation</a>, <a class="el" href="struct_x_dfe_ofdm___internal_carrier_cfg.html#a2162ce8645de30643f71dcd6daeaae15">XDfeOfdm_InternalCarrierCfg::PhaseCompensation</a>, <a class="el" href="struct_x_dfe_ofdm___carrier_cfg.html#a5e7eccd516549e6547c4881c74bf578c">XDfeOfdm_CarrierCfg::ScaleFactor</a>, <a class="el" href="struct_x_dfe_ofdm___internal_carrier_cfg.html#ad9ec683d3980800f0a067b0e329f749c">XDfeOfdm_InternalCarrierCfg::ScaleFactor</a>, <a class="el" href="group__dfeofdm.html#ga8781db2b27a846747e58ff160bea6751">XDFEOFDM_PHASE_COMPENSATION_MAX</a>, <a class="el" href="group__dfeofdm.html#ga9478d2b97aa40e09052dee2571940ef9">XST_FAILURE</a>, and <a class="el" href="group__dfeofdm.html#ga959ffc15251ddc9b3a883a30f97b7715">XST_SUCCESS</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
